Create GitLab project for process documentation to migrate stable hedgedocs
This task includes
-
choose where this process documentation project should go -> specifically docs that are relevant for the team only -
decide what it should include and the tree structure -
define visibility = all staff (staff only) -
create project and tree structure
Out of scope of this task
- migration of hedgedocs
Context
A summary of the following article: https://blog.prototypr.io/software-documentation-types-and-best-practices-1726ca595c7f
Product documentation
Product documentation describes the product that is being developed and provides instructions on how to perform various tasks with it. Product documentation can be broken down into:
System documentation and
User documentation
- System documentation :
- requirements documents: the system functionality (business rules, user stories, use cases, product’s purpose, its features, functionalities, and behavior)
- design decisions,
- architecture descriptions,
- program source code,
- and help guides.
- User documentation:
- manuals for end-users of the product
- manuals for the system administrators.
- User documentation includes tutorials, user guides, troubleshooting manuals, installation, and reference manuals.
- FAQs
- Video tutorials
- Embedded assistance
- Support Portals
- Q&A documentation
- Test strategy
- Test plan (list of features to be tested, testing methods, timeframes, roles and responsibilities (e.g. unit tests may be performed either by the QA team or by engineers))
- Test case specifications - a set of detailed actions to verify each feature or functionality of a product.
- Test checklists -list of tests that should be run at a particular time.
Process documentation
- project plans,
- test schedules,
- reports,
- meeting notes,
- or even business correspondence.
- Working papers (engineers’ ideas and thoughts during project implementation)
- Standards (https://wiki.softwareheritage.org/wiki/Code_review_in_Phabricator)
Bottom line: We should use tags on hedgedocs and move "important" hedgedocs to a permanent location