Roles and responsibilities
Product Owners and Product Experts
Product owners and product experts play a crucial role in the documentation process. They are responsible for providing the necessary information and input to the documentation team to create accurate and comprehensive documentation for the products.
Product owners are responsible for their own product documentation. Product owners should regularly check their documentation to ensure it is complete and readable. Product owners must evaluate the release notes, open a case in Fogbugz, establish priorities, and notify the documentation team.
-
Minor updates (like updating screenshots) don’t need a lengthy description. Just create a FogBugz case for Documentation with reference to the relevant release note.
-
Major updates and new features require Product Owners to define the substance of the documentation. It is needed to include high-quality images (.png files) with the input files. Provide the input in asciidoc format (if possible) or in a basic word document for the documentation team to work with.
-
Minute updates can be added directly in the respective product’s GitHub repository. Create a FogBugz case to inform the documentation team about this minute update. This will help the documentation team in processing the branch for review and merge.
Procedure for minute updates in GitHub:
-
Navigate to the file you want to edit.
-
Click on Edit this file icon and edit your changes.
-
After editing, click Commit changes… to create a new branch with a commit message.
-
Type the commit message, add description, select Creating a new branch for this commit, and type the branch name.
-
Click Propose changes to create a pull request.
-
Goto the Pull Request and assign it to documentation team member.
-
After the documentation team has reviewed and merged the changes into the main branch, close the FogBugz case.
Documentation Team
The documentation team is responsible for:
-
Updating the documentation according the Fogbugz cases created by the Product Owners.
-
Work on major updates (convert input file to asciidoc format), commit changes and assign pull request for review.
Complex Document Tasks
For complex file conversions or creating complex document structures, reach out to the documentation team directly.