IEEE Std 1063-1987 IEEE Standard for Software User Documentation -Description

Content

• 1. Scope
• • 1.1 Applicability.
  • 1.2 Organization.
• 2. Definitions
• 3. Identifying Required User Documents
• • 3.1 Identifying the Software.
  • 3.2 Determining the Document Audience.
  • 3.3 Determining the Document Set.
  • 3.4 Determining Document Usage Modes.
  • • 3.4.1 Instructional Mode.
    • 3.4.2 Reference Mode.
• 4. User Document Inclusion Requirements
• 5. User Document Content Requirements
• • 5.1 Title Page.
  • 5.2 Restrictions.
  • 5.3 Warranties and Contractual Obligations.
  • 5.4 Table of Contents.
  • • 5.4.1 Comprehensive Table of Contents.
    • 5.4.2 Simple Table of Contents.
  • 5.5 List of Illustrations.
  • 5.6 Introduction.
  • • 5.6.1 Audience Description.
    • 5.6.2 Applicability Statement.
    • 5.6.3 Purpose Statement.
    • 5.6.4 Document Usage Description.
    • 5.6.5 Related Documents.
    • 5.6.6 Conventions.
    • 5.6.7 Problem Reporting Instructions.
  • 5.7 Body of Document.
  • • 5.7.1 Body of Instructional Mode Documents.
    • 5.7.2 Body of Reference Mode Documents.
  • 5.8 Error Messages, Known Problems, and Error Recovery.
  • 5.9 Appendixes.
  • 5.10 Bibliography.
  • 5.11 Glossary.
  • 5.12 Index.
• 6. User Document Presentation Requirements
• • 6.1 Highlighting.
  • 6.2 Consistency.
  • 6.3 Terminology.
  • 6.4 Referencing Related Material.
• 7. Bibliography

links: [Standard Status] - [Purchase] - [PDF^*] - [Software Engineering Collection - Description]

available for Standards Online Software Engineering Collection subscribers only