The intent of this guideline is to detail the basic requirements for documenting a work product.
The documents should be :
Precise and concise
Structured in a clear manner
Easy to understand by the intended users
Maintainable (i.e. do not repeat information in other sources, use cross referencing)
Each work product of document should have the following attributes of information published with them.
The title, referring to the scope of the content
The author and approver
Unique identifier for each version or revision of a document or work product
Change history (i.e. for each change the name of the author, the date and brief description of the change)
The status (i.e. Draft, Released)
|