Information required for Documentation Team
The main input channel for documentation team is creating a case in FogBugz.
When a case is assigned to the documentation team in FogBugz, the following information is vital to create a high-quality document:
-
Select the category of the case (feature, refinement, or bug), build release information, priority, and any relevant tags.
-
Attach any relevant documents and files.
-
History of case requirement with context, purpose, and intended audience.
-
Localization needs (flavoring and translation).
-
Find where to insert/create the context.
-
Conduct impact analysis to find what impact this new context will have on existing document.
-
Quality images to support the document.
-
Hazard statement (safety topics), if any, to include in the document.
-
Discussion with a documentation team member to provide extended support to clearly understand the case.
-
If required, documentation team members collaborate with the testers while practically testing the case.
Most of the information can be found in the FogBugz case entries, but it is the responsibility of the documentation team member to gather all relevant information before starting to work on a case.