IEEE-STD-1063-2001 IEEE Standard for Software User Documentation

jwyin_cn

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

admin

谢谢您的分享,金币已奖励!