Tables of Contents of the Document production, version control and filing standards:
Document production standard
contents1. Introduction 2
1.1. Scope 2
1.2. Objectives 3
1.3. References & sources 3
1.4. Definitions & acronyms 3
1.5. Responsibilities 3
2. Standard description 4
2.1. Wordprocessor documents 4
2.1.1. Document identification & content 4
2.1.1.1. Title page 4
2.1.1.2. Preface 5
2.1.1.3. Contents 5
2.1.1.4. List of illustrations 6
2.1.1.5. References 6
2.1.1.6. Headers/footers 7
2.1.1.7. Security 7
2.1.1.8. Appendixes 7
2.1.2. Document organisation 8
2.1.3. Document format 8
2.1.3.1. Page size and margins 8
2.1.3.2. Headings 8
2.1.3.3. Body text 9
2.1.3.4. Bullets 9
2.1.3.5. Numbered lists 9
2.1.3.6. Justification 9
2.1.3.7. Figures & numerals 9
2.1.3.8. Italics 9
2.1.3.9. Emphasis 10
2.1.3.10. Hyphenation 10
2.1.3.11. Acronyms & jargon 10
2.1.3.12. Other formatting considerations 10
2.2. Writing style 10
2.2.1. Economy of words 11
2.2.2. Active voice 11
2.2.3. Present tense 11
2.2.4. Other considerations 11
2.2.5. List conventions 12
2.3. Document issue & control 12
2.3.1. Approval 12
2.3.2. Document quality 13
2.3.3. Identification of changes 13
2.3.4. Document release 13
2.3.5. Version control & re-issue of documents 14
2.3.6. Controlled distribution documents 14
2.3.7. Document storage 14
2.4. Correspondence 15
2.4.1. Letters, facsimiles, memorandums 15
2.4.2. Email 15
2.4.3. Approval 15
2.5. Spreadsheets, schedules 15
2.6. Powerpoint presentations 16
2.7. User documentation 16
2.8. Other 16
Version control of deliverables
contents1. Introduction 2
1.1. Scope 2
1.2. Objectives 2
1.3. References & sources 3
1.4. Definitions & acronyms 3
1.5. Responsibilities 4
2. Standard description 4
2.1. Placement of version identification 4
2.2. Version terminology 4
2.3. Version identification 4
2.3.1. Software version identification 5
2.3.2. Document version identification 6
2.4. Status 7
2.4.1. Software status 7
2.4.2. Document status 8
Project document filing
contents1. Introduction 2
1.1. Scope 2
1.2. Objectives 2
1.3. References & sources 2
1.4. Definitions & acronyms 2
1.5. Responsibilities 3
2. Standard description 3
2.1. Document identification code 3
2.1.1. Project code (PPP) 4
2.1.2. Document code (TT-SS-nnn) 4
2.1.2.1. Document type (TT) 4
2.1.2.2. Document subject (TT-SS) 4
2.1.2.3. Three digit number (nnn) 5
2.2. Document filing 5
2.2.1. Project document register 5
2.2.2. Project file 6
2.2.3. Storage of document softcopies 6
2.2.3.1. Project document register file 8
2.2.3.2. File naming convention 8
2.2.4. Document subjects 8
2.2.5. Document type and subject descriptions 10
2.2.5.1. Project initiation (PI-) 10
2.2.5.2. Project correspondence (PC-) 11
2.2.5.3. Project management (PM-) 11
2.2.5.4. Configuration management (CM-) 13
2.2.5.5. Technical documentation (TD-) 13
2.2.5.6. Quality assurance (QA-) 14
2.2.5.7. Verification & validation (VV-) 15
2.2.5.8. User documentation (UD-) 16
2.2.5.9. Support activities (SU-) 16