IEEE 1063 : 2001

Table of Contents

1. Overview
   1.1 Scope
   1.2 Purpose
   1.3 Organization of the standard
   1.4 Candidate uses
2. Definitions
3. Structure of software user documentation
   3.1 Overall structure of documentation
   3.2 Initial components
   3.3 Placement of critical information
4. Information content of software user documentation
   4.1 Completeness of information
   4.2 Accuracy of information
   4.3 Content of identification data
   4.4 Information for use of the documentation
   4.5 Concept of operations
   4.6 Information for general use of the software
   4.7 Information for procedures and tutorials
   4.8 Information on software commands
   4.9 Information on error messages and problem resolution
   4.10 Information on terminology
   4.11 Information on related information sources
5. Format of software user documentation
   5.1 Consistency of terminology and formats
   5.2 Use of printed or electronic formats
   5.3 Legibility
   5.4 Formats for warnings, cautions, and notes
   5.5 Format for instructions
   5.6 Formats for representing user interface elements
   5.7 Formats for documentation features for accessing
        information
   5.8 Formats for features for navigation
   5.9 Formats for illustrations
Annex A (informative) - Bibliography
Annex B (informative) - Indexing software user documentation
Index

Abstract

Provides minimum requirements on the structure and information content of user documentation. Coverage includes definitions, identifying the software, title page, body of a document, determining the document set, terminology, glossary, index, highlighting, consistency, determining the document audience, and warranties and contractual obligations, and referencing related material.

General Product Information

Published
Document Type	Standard
Status	Current
Publisher	Institute of Electrical & Electronics Engineers
Pages
ISBN
Supersedes	IEEE DRAFT 1063 : 200D4