IEEE 1063-2001
Superseded
A superseded Standard is one, which is fully replaced by another Standard, which is a new edition of the same Standard.
View Superseded by
IEEE Standard for Software User Documentation
01-06-2011
English
20-12-2001
Important note : Users cannot be edited or removed once added to your Multi user PDF.
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
This standard provides minimum requirements for the structure, information content, and format of user documentation, to include both paper and electronic documentation used in the work environment by users of systems containing software.
| Committee |
Software & Systems Engineering Standards Comm
|
| DevelopmentNote |
Supersedes IEEE DRAFT 1063 (01/2002)
|
| DocumentType |
Standard
|
| ISBN |
978-0-7381-3099-6
|
| Pages |
24
|
| PublisherName |
Institute of Electrical & Electronics Engineers
|
| Status |
Superseded
|
| SupersededBy | |
| Supersedes |
| ASTM F 1756 : 1997 : REV A : R2008 | Standard Guide for Implementation of a Fleet Management System Network (Withdrawn 2015) |
| ASTM F 1756 : 1997 : REV A : R2002 | Standard Guide for Implementation of a Fleet Management System Network |
| ASTM E 2066 : 2000 | Standard Guide for Validation of Laboratory Information Management Systems |
| ASTM E 2538 : 2006 : R2011 | Standard Practice for Defining and Implementing Pharmacotherapy Information Services within the Electronic Health Record (EHR) Environment and Networked Architectures (Withdrawn 2020) |
| ASTM E 2473 : 2005 : R2011 | Standard Practice for the Occupational/Environmental Health View of the Electronic Health Record (Withdrawn 2020) |
| BS ISO/IEC 26514:2008 | Software and systems engineering. Requirements for designers and developers of user documentation |
| ASTM E 1340 : 2005 | Standard Guide for Rapid Prototyping of Information Systems |
| ASTM F 1716 : 1996 : R2015 | Standard Guide for Transition and Performance of Marine Software Systems Maintenance |
| IEEE DRAFT 1074 : 0 | DEVELOPING SOFTWARE LIFE CYCLE PROCESSES |
| ASTM E 2538 : 2006 | Standard Practice for Defining and Implementing Pharmacotherapy Information Services within the Electronic Health Record (EHR) Environment and Networked Architectures |
| ASTM F 1716 : 1996 : R2008 | Standard Guide for Transition and Performance of Marine Software Systems Maintenance |
| CSA ISO/IEC 26514 : 2013 | SYSTEMS AND SOFTWARE ENGINEERING - REQUIREMENTS FOR DESIGNERS AND DEVELOPERS OF USER DOCUMENTATION |
| ASTM E 919 : 1996 | Specification for Software Documentation for a Computerized System (Withdrawn 2000) |
| ASTM E 2066 : 2000 : R2007 | Standard Guide for Validation of Laboratory Information Management Systems (Withdrawn 2015) |
| ASTM F 1716 : 1996 : R2002 | Standard Guide for Transition and Performance of Marine Software Systems Maintenance |
| ASTM F 1756 : 1997 : REV A | Standard Guide for Implementation of a Fleet Management System Network |
| ISO/IEC 26514:2008 | Systems and software engineering Requirements for designers and developers of user documentation |
| ASTM E 792 : 2002 | Standard Guide for Selection of a Clinical Laboratory Information Management System |
| ASTM F 1756 : 1997 | Standard Guide for Implementation of a Fleet Management System Network |
| ASTM E 2473 : 2005 | Standard Practice for the Occupational/Environmental Health View of the Electronic Health Record |
| CAN/CSA-ISO/IEC 26514:13 (R2017) | Systems and software engineering - Requirements for designers and developers of user documentation (Adopted ISO/IEC 26514:2008, first edition, 2008-06-15) |
| ASTM E 1340 : 2005 : R2010 | Standard Guide for Rapid Prototyping of Information Systems (Withdrawn 2017) |
| IEEE 1074-2006 | IEEE Standard for Developing a Software Project Life Cycle Process |
| ASTM E 731 : 1997 | Guide for Selection and Acquisition of Commercially Available Computerized Systems (Withdrawn 2000) |
| IEEE 12207.1-1997 | IEEE/EIA Guide - Industry Implementation of International Standard ISO/IEC 12207 : 1995 (ISO/IEC 12207) - Software Life Cycle Processes - Life Cycle Data |
| IEEE 610.12-1990 | IEEE Standard Glossary of Software Engineering Terminology |
| ISO/IEC TR 9294:2005 | Information technology Guidelines for the management of software documentation |
| ISO/IEC 15910:1999 | Information technology Software user documentation process |
| BS 7830:1996 | Guide to the design and preparation of on-screen documentation for users of application software |
| BS 7649:1993 | Guide to the design and preparation of documentation for users of application software |
Access your standards online with a subscription
Features
-
Simple online access to standards, technical information and regulations.
-
Critical updates of standards and customisable alerts and notifications.
-
Multi-user online standards collection: secure, flexible and cost effective.