1、 IEEE Std 90003-2008 IEEE Std 90003-2008 IEEE Standard for Adoption of ISO/IEC 26514:2008 Systems and Software EngineeringRequirements for Designers and Developers of User Documentation Sponsored by the Software +1 978 750 8400. Permission to photocopy portions of any individual standard for educati
2、onal classroom use can also be obtained through the Copyright Clearance Center. iv Copyright 2011 IEEE. All rights reserved. Introduction This introduction is not part of IEEE Std 26514-2010, IEEE Standard for Adoption of ISO/IEC 26514:2008, Systems and Software EngineeringRequirements for Designers
3、 and Developers of User Documentation. Well-designed documentation not only assists the user and helps to reduce the cost of training and support, but also enhances the reputation of the product, its producer, and its suppliers. This standard specifies the processes for designing and developing soft
4、ware user documentation, and provides the minimum requirements for these activities. It covers establishing project requirements, objectives, and constraints; audience and task analysis; user documentation design, development, and review. It is relevant to project managers, information designers and
5、 usability specialists, and information developers such as writers, editors, and illustrators. It applies to both printed and on-screen user documentation, whether produced concurrently with the software or subsequently. This standard is independent of the software tools that might be used to produc
6、e documentation. Much of its guidance is applicable to user documentation for systems including hardware as well as to software user documentation. In addition to defining a standard process for the design and development of user documentation, this standard also covers the documentation product. Th
7、is standard specifies the structure, content, and format for use documentation, and also provides informative guidance for user documentation style. Earlier standards tended to view the results of the documentation process as a single book or multivolume set: a one-time deliverable. Increasingly, do
8、cumentation designers recognize that most user documentation is now produced from managed re-use of previously developed information (single-source documentation), adapted for new software versions or presentation in various on-screen and printed media. While this standard does not describe how to s
9、et up a content management system, it is applicable for documentation organizations practicing single-source documentation. The IEEE contributed IEEE Std 1063-2001, IEEE Standard for Software User Documentation, as a source for this standard. IEEE Std 26514-2010 completely supersedes and replaces IE
10、EE Std 1063-2001. This standard is part of a series including IEEE Std 26513-2010, IEEE Standard for Adoption of ISO/IEC 26513:2009, Systems and Software EngineeringRequirements for Testers and Reviewers of Documentation. Other standards in the 2651N series are forthcoming to address requirements fo
11、r user documentation management and for acquisition and supply of user documentation. It conforms to the information management and software documentation management processes required in ISO/IEC 15288:2008 (IEEE Std 15288-2008), Systems and software engineering System life cycle processes, and ISO/
12、IEC 12207:2008 (IEEE Std 12207-2008), Systems and software engineering Software life cycle processes. Notice to users Laws and regulations Users of these documents should consult all applicable laws and regulations. Compliance with the provisions of this standard does not imply compliance to any app
13、licable regulatory requirements. Implementers of the standard are responsible for observing or referring to the applicable regulatory requirements. IEEE does not, by the publication of its standards, intend to urge action that is not in compliance with applicable laws, and these documents may not be
14、 construed as doing so. v Copyright 2011 IEEE. All rights reserved. Copyrights This document is copyrighted by the IEEE. It is made available for a wide variety of both public and private uses. These include both use, by reference, in laws and regulations, and use in private self-regulation, standar
15、dization, and the promotion of engineering practices and methods. By making this document available for use and adoption by public authorities and private users, the IEEE does not waive any rights in copyright to this document. Updating of IEEE documents Users of IEEE standards should be aware that
16、these documents may be superseded at any time by the issuance of new editions or may be amended from time to time through the issuance of amendments, corrigenda, or errata. An official IEEE document at any point in time consists of the current edition of the document together with any amendments, co
17、rrigenda, or errata then in effect. In order to determine whether a given document is the current edition and whether it has been amended through the issuance of amendments, corrigenda, or errata, visit the IEEE Standards Association web site at http:/ieeexplore.ieee.org/xpl/standards.jsp, or contac
18、t the IEEE at the address listed previously. For more information about the IEEE Standards Association or the IEEE standards development process, visit the IEEE-SA web site at http:/standards.ieee.org. Errata Errata, if any, for this and all other standards can be accessed at the following URL: http
19、:/standards.ieee.org/reading/ieee/updates/errata/index.html. Users are encouraged to check this URL for errata periodically. Interpretations Current interpretations can be accessed at the following URL: http:/standards.ieee.org/reading/ieee/interp/ index.html. Patents Attention is called to the poss
20、ibility that implementation of this standard may require use of subject matter covered by patent rights. By publication of this standard, no position is taken with respect to the existence or validity of any patent rights in connection therewith. The IEEE is not responsible for identifying Essential
21、 Patent Claims for which a license may be required, for conducting inquiries into the legal validity or scope of Patents Claims or determining whether any licensing terms or conditions provided in connection with submission of a Letter of Assurance, if any, or in any licensing agreements are reasona
22、ble or non-discriminatory. Users of this standard are expressly advised that determination of the validity of any patent rights, and the risk of infringement of such rights, is entirely their own responsibility. Further information may be obtained from the IEEE Standards Association. vi Copyright 20
23、11 IEEE. All rights reserved. Participants At the time this standard was submitted to the IEEE-SA Standards Board for approval, the 26514 User Documentation Design Working Group had the following membership: Annette Reilly, Chair for Adoption James Moore, Computer Society Liaison Representative to I
24、SO/IEC JTC 1/SC 7 The following members of the individual balloting committee voted on this standard. Balloters may have voted for approval, disapproval, or abstention. Chris Bagge Bakul Banerjee Hugh Barrass H Stephen Berger Juris Borzovs Pieter Botman Lyle Bullock Juan Carreon Keith Chow Paul Crol
25、l Geoffrey Darnton David Deighton Thomas Dineen Scott Duncan Sourav Dutta Kenneth Echeberry Harriet Feldman Andrew Fieldsend Eva Freund David Friscia David Fuschi Gregg Giesler Randall Groves John Harauz George Hayhoe Mark Henley Frank Hill Werner Hoelzl Robert Holibaugh Bernard Homes Atsushi Ito Ma
26、rk Jaeger Piotr Karocki Rameshchandra Ketharaju Thomas Kurihara Susan Land David Leciston Daniel Lindberg Greg Luri Edward Mccall James Moore Finnbarr Murphy Michael S. Newman William Petit Ulrich Pohl Iulian Profir Gerald Radack Annette Reilly Robert Robinson Randall Safier Helmut Sandmayr Bartien
27、Sayogo Robert Schaaf Maud Schlich David J Schultz Stephen Schwarm Gil Shultz Carl Singer Steven Smith Luca Spotorno Thomas Starai Walter Struppler Marcy Stutzman K Subrahmanyam Thomas Tullia David Walden Paul Work Oren Yuen Janusz Zalewski When the IEEE-SA Standards Board approved this standard on 8
28、 November 2010, it had the following membership: Robert M. Grow, Chair Richard H. Hulett, Vice Chair Steve M. Mills, Past Chair Judith Gorman, Secretary Karen Bartleson Victor Berman Ted Burse Clint Chaplin Andy Drozd Alexander Gelman Jim Hughes Young Kyun Kim Joseph L. Koepfinger* John Kulick David
29、 J. Law Hung Ling Oleg Logvinov Ted Olsen Ronald C. Petersen Thomas Prevost Jon Walter Rosdahl Sam Sciacca Mike Seavey Curtis Siller Don Wright *Member Emeritus vii Copyright 2011 IEEE. All rights reserved. Also included are the following nonvoting IEEE-SA Standards Board liaisons: Satish Aggarwal,
30、NRC Representative Richard DeBlasio, DOE Representative Michael Janezic, NIST Representative Lisa Perry IEEE Standards Program Manager, Document Development Malia Zaman IEEE Standards Program Manager, Technical Program Development Jodi Haasz IEEE Senior Program Manager, International Standards Progr
31、ams viii Copyright 2011 IEEE. All rights reserved. Contents of IEEE Adoption of ISO/IEC 26514:2008 ISO/IEC 26514:2008 . 1 IEEE Standard for Adoption of ISO/IEC 26514:2008 Systems and Software EngineeringRequirements for Designers and Developers of User Documentation IMPORTANT NOTICE: This standard i
32、s not intended to ensure safety, security, health, or environmental protection. Implementers of the standard are responsible for determining appropriate safety, security, environmental, and health practices or regulatory requirements. This IEEE document is made available for use subject to important
33、 notices and legal disclaimers. These notices and disclaimers appear in all publications containing this document and may be found under the heading “Important Notice” or “Important Notices and Disclaimers Concerning IEEE Documents.” They can also be obtained on request from IEEE or viewed at http:/
34、standards.ieee.org/IPR/disclaimers.html. Reference numberISO/IEC 26514:2008(E)ISO/IEC 2008INTERNATIONAL STANDARD ISO/IEC26514First edition2008-06-15Systems and software engineering Requirements for designers and developers of user documentation Ingnierie du logiciel et des systmes Exigences pour les
35、 concepteurs et les dveloppeurs de la documentation de lutilisateur ISO/IEC 26514:2008(E) PDF disclaimer This PDF file may contain embedded typefaces. In accordance with Adobes licensing policy, this file may be printed or viewed but shall not be edited unless the typefaces which are embedded are li
36、censed to and installed on the computer performing the editing. In downloading this file, parties accept therein the responsibility of not infringing Adobes licensing policy. The ISO Central Secretariat accepts no liability in this area. Adobe is a trademark of Adobe Systems Incorporated. Details of
37、 the software products used to create this PDF file can be found in the General Info relative to the file; the PDF-creation parameters were optimized for printing. Every care has been taken to ensure that the file is suitable for use by ISO member bodies. In the unlikely event that a problem relatin
38、g to it is found, please inform the Central Secretariat at the address given below. COPYRIGHT PROTECTED DOCUMENT ISO/IEC 2008 All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized in any form or by any means, electronic or mechanical, including ph
39、otocopying and microfilm, without permission in writing from either ISO at the address below or ISOs member body in the country of the requester. ISO copyright office Case postale 56 g120 CH-1211 Geneva 20 Tel. + 41 22 749 01 11 Fax + 41 22 749 09 47 E-mail copyrightiso.org Web www.iso.org Published
40、 in Switzerland ii ISO/IEC 2008 All rights reservedISO/IEC 26514:2008(E) ISO/IEC 2008 All rights reserved iiiContents Page Foreword viii Introduction . ix 1 Scope . 1 2 Conformance. 3 2.1 Application of conformance 3 2.2 Conformance situations. 3 3 Normative references . 4 4 Terms and definitions. 4
41、 5 User documentation process within the systems/software life cycle. 10 6 Project requirements, objectives, and constraints . 13 6.1 Project objectives . 13 6.2 User documentation requirements and constraints . 14 6.3 Project goals and constraints . 15 6.3.1 Project infrastructure and tools 16 6.3.
42、2 Schedule constraints 16 6.4 Users and usability objectives 17 6.5 Interviewing technical contacts and other experts . 19 6.6 Project planning 19 6.6.1 Quality management. 20 6.6.2 Version control and change control . 21 6.6.3 Availability of resources 21 6.6.4 Schedules 22 6.6.5 Cost estimating .
43、23 6.6.6 Planning for localization and customization . 24 6.7 Documentation proposal . 24 7 Analysis and design . 25 7.1 Audience and task analysis. 25 7.1.1 Audience analysis. 25 7.1.2 Audience profiles 27 7.1.3 Task analysis. 28 7.2 User documentation design 30 7.2.1 Designing for use of content .
44、 31 7.2.2 Designing formats 31 8 Development and review 32 8.1 Prototypes and drafts. 32 8.1.1 CM during development. 33 8.1.2 Development of translated and localized documentation 33 8.2 Evaluation of documentation 34 8.2.1 Other roles in evaluation of documentation quality 35 8.2.2 Documentation r
45、eview procedures. 36 8.3 Documentation testing. 38 8.3.1 Types of documentation tests. 38 8.3.2 Usability tests 39 9 Production . 40 9.1 Final assembly and review 40 9.2 Approval 40 9.3 CM. 41 ISO/IEC 26514:2008(E) iv ISO/IEC 2008 All rights reserved9.4 Updating and maintenance 41 10 Structure of do
46、cumentation. 41 10.1 Overall structure of documentation 42 10.1.1 Structure of instructional mode documentation 43 10.1.2 Structure of reference mode documentation. 43 10.2 Structure of documentation according to audience needs 43 10.3 Size of topics in onscreen documentation. 45 10.4 User documenta
47、tion components. 46 10.5 Placement of user documentation components 47 10.5.1 Initial components 47 10.5.2 Placement of critical information 47 11 Information content of user documentation 47 11.1 Completeness of information 48 11.2 Accuracy of information. 48 11.3 Content of identification data 48
48、11.4 Information for use of the documentation49 11.5 Concept of operations 50 11.6 Information for general use of the software.51 11.7 Information for procedures and tutorials . 52 11.7.1 Preliminary information for procedures . 52 11.7.2 Procedural steps . 52 11.7.3 Completion information for proce
49、dures .53 11.7.4 Tutorials . 54 11.8 Information on software commands . 54 11.9 Explanations of data entry fields. 55 11.10 Content of error messages and problem resolution . 55 11.11 Content of warnings and cautions 56 11.12 Information on terminology . 57 11.13 Information on related information sources 57 11.14 User-supplied content 58 12 Presentation format of documentation. 59 12.1 General . 59 12.2 Use of printed or on-screen formats. 60 12.3 Selection of appropriate media and format 61 12.3.1 Comparison of media . 61 12.3.2 Relati
