Document Owner Responsibilities
Each document in the Official OSG Documentation TWiki must have an Owner. Document Owners should also be familiar with the responsibilities of the Reviewers
The owner of a document should have knowledge about the topic of the document and is responsible for:
- Creating the document (if it doesn't exist) in either the Documentation Web (for general, non-release dependent documents) or Release3 Web (for documents that tend to change with releases). When creating the document, a template can be chosen on the topic creation page via a drop down list. See document types for a description of the provided templates. After creating the document, you will be in the editor with the new page and you can edit the contents.
- Inserting and updating the Content Management Variables in the HTML block at the end of the document. The templates all contain the Content Management Variables but the values will need to be updated.
- Testing or ensuring that testing is done on the software and version the document applies to.
- Updating/improving the document. [For minor updates, you can just edit the released document. For an extensive rewrite, you may want to create a copy in a team web and replace the official document (using copy and paste) after you have had the new one reviewed.] Updates should be done when:
- Errors are discovered (typically by document users or the Trash/Trash/Integration or Documentation Teams).
- Users make comments in the document noting problems or improvements needed.
- Software or other changes make the document out of date.
- A new OSG release requires a change in the document.
- The document is identified by the Ongoing Evaluation/Improvement Process as needing improvement (up to 2 times a year).
- Working in collaboration with the Reviewer of the document to resolve issues identified by the Reviewer after each significant update. Set the REVIEW_READY variable to %YES% and the REVIEW_PASSED variable to %IN_PROGRESS% and email the reviewer to initiate the review.
- Working in collaboration with the Tester of the document to resolve issues from a test of procedures (if applicable). Set the TEST_READY variable to %YES% and the TEST_PASSED variable to %IN_PROGRESS% and email the tester to initiate the test.
- Setting the RELEASE_READY variable to %YES% when you and the reviewer [and Tester] are satisfied with the document.
- Notifying the Document Architect if unable to continue to fulfill the responsibilities of the Owner.
- 06 Oct 2009
Topic revision: r25 - 01 Dec 2016 - 20:53:00 - KyleGross