IT:AD:Documentation:HowTo:Standard Document Structure
- See also:
Document Title
- Document Title Page
- Recommend against repeating information available in Revision History on next page.
- Title
- Date
- Version
- Author
- Document Control Information
- Document Contact (Name/Email of Author)
- Revision History [Table: Version, Date, Change Details, By, Reviewers/Endorsers (Name,Role,Responsibility)]
- Template Information
- Approved By
- Reviewed By
- COnsulted
- Distributed To
- Figures and Tables
- Table Of Contents (No deeper than 3)
- Introduction
- Purpose (eg: 'To Describe XXX…')
- Scope (Optional as not all docs need scope defined)
- Includes:
- Excludes:
- Audience (Grouped list, by Org/Department)
- StakeHolders <(Grouped list)
- Prerequsites (Not suitable for all doc types)
- Assumptions (Not suitable for all doc types)
- Definitions, Acronyms, and Abbreviations (Refer to Appendices)
- Living Document - Appendix - Notations and Terminology - Terminology * Words specific to doc (DOL, LINZ, W3C, etc…… - Notations *. MUST MUST NOT REQUIRED SHALL SHOULD SHOULD NOT OPTIONAL - References * List of external documents