IEEE 26513-2010 en Adoption of ISO IEC 26513 2009 Systems and Software EngineeringRequirements for Testers and Reviewers of Documentation (IEEE Computer Society.pdf

1、 IEEE Std 90003-2008 IEEE Std 90003-2008 IEEE Standard for Adoption of ISO/IEC 26513:2009 Systems and Software EngineeringRequirements for Testers and Reviewers of User Documentation Sponsored by the Software +1 978 750 8400. Permission to photocopy portions of any individual standard for educationa

2、l 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 26513-2010, IEEE Standard for Adoption of ISO/IEC 26513:2009, Systems and Software EngineeringRequirements for Testers and

3、Reviewers of User Documentation. Usable documentation not only assists software users 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 activities for reviewing and testing user documentatio

4、n, and provides the minimum requirements for these activities. It covers review procedures for user documentation, as well as system testing, usability testing, accessibility testing, and localization and customization testing of user documentation. It is relevant to project managers, editors, usabi

5、lity experts, testers, documentation reviewers, and information developers. It applies to both printed and on-screen user documentation. It applies to both initial development and subsequent releases of the software and user documentation. This standard is independent of the software tools that migh

6、t be used to produce documentation. Much of its guidance is applicable to user documentation for systems including hardware as well as to software user documentation. This standard is part of a series including IEEE Std 26514-2010, IEEE Standard for Adoption of ISO/IEC 26514:2008, Systems and Softwa

7、re EngineeringRequirements for Designers and Developers of User Documentation. Other standards in the 2651N series are forthcoming to address requirements for user documentation management and for acquisition and supply of user documentation. It is based on the processes required in ISO/IEC 15288:20

8、08 (IEEE Std 15288-2008), Systems and software engineering System life cycle processes, and ISO/IEC 12207:2008 (IEEE Std 12207-2008), Systems and software engineering Software life cycle processes. This standard describes the activities involved in the Documentation Management and Validation process

9、es of ISO/IEC 12207:2008 (IEEE Std 12207-2008), from the viewpoint of the user documentation tester. 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 appl

10、icable 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

11、construed as doing so. 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, standardization, and the promotion of engineering pr

12、actices 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. v Copyright 2011 IEEE. All rights reserved. Updating of IEEE documents Users of IEEE standards should be aware that t

13、hese 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, cor

14、rigenda, 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 contact

15、 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:

16、/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 possi

17、bility 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

18、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 reasonab

19、le 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. Participants At

20、the time this standard was submitted to the IEEE-SA Standards Board for approval, the User Documentation Test and Review Working Group had the following membership: Annette Reilly, Chair for Adoption James Moore, Computer Society Liaison Representative to ISO/IEC JTC 1/SC 7 vi Copyright 2011 IEEE. A

21、ll rights reserved. The following members of the individual balloting committee voted on this standard. Balloters may have voted for approval, disapproval, or abstention. Chris Bagge Hugh Barrass H Stephen Berger Juris Borzovs Pieter Botman Lyle Bullock Juan Carreon Keith Chow Paul Croll Geoffrey Da

22、rnton David Deighton Thomas Dineen Scott Duncan Sourav Dutta Kenneth Echeberry Harriet Feldman Andrew Fieldsend Eva Freund David Friscia David Fuschi Gregg Giesler Randall Groves Jon Hagar John Harauz George Hayhoe Mark Henley Frank Hill Werner Hoelzl Robert Holibaugh Atsushi Ito Mark Jaeger Piotr K

23、arocki Rameshchandra Ketharaju Thomas Kurihara Susan Land David Leciston Daniel Lindberg Greg Luri Edward Mccall James Moore Finnbarr Murphy Michael S. Newman Nick S. A Nikjoo William Petit Ulrich Pohl Iulian Profir Gerald Radack Annette Reilly Robert Robinson Randall Safier Helmut Sandmayr Bartien

24、Sayogo Robert Schaaf Maud Schlich David J Schultz Stephen Schwarm Gil Shultz Carl Singer Michael Smith Luca Spotorno Thomas Starai Walter Struppler Marcy Stutzman Thomas Tullia David Walden Oren Yuen When the IEEE-SA Standards Board approved this standard on 8 November 2010, it had the following mem

25、bership: 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 J. Law Hung Ling Oleg Logvinov Ted Olse

26、n Ronald C. Petersen Thomas Prevost Jon Walter Rosdahl Sam Sciacca Mike Seavey Curtis Siller Don Wright *Member Emeritus Also included are the following nonvoting IEEE-SA Standards Board liaisons: Satish Aggarwal, NRC Representative Richard DeBlasio, DOE Representative Michael Janezic, NIST Represen

27、tative 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 Programs vii Copyright 2011 IEEE. All rights reserved. Contents of IEEE Adoption of ISO/IEC

28、 26513:2009 ISO/IEC 26513:2009 . 1 1 Copyright 2011 IEEE. All rights reserved. IEEE Standard for Adoption of ISO/IEC 26513:2009 Systems and Software EngineeringRequirements for Testers and Reviewers of User Documentation IMPORTANT NOTICE: This standard is not intended to ensure safety, security, hea

29、lth, 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 notices and legal disclaimers. These notices

30、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:/standards.ieee.org/IPR/disclaimers.html. Refer

31、ence numberISO/IEC 26513:2009(E)ISO/IEC 2009INTERNATIONAL STANDARD ISO/IEC26513First edition2009-10-15Systems and software engineering Requirements for testers and reviewers of user documentation Ingnierie des systmes et du logiciel Exigences pour testeurs et vrificateurs de documentation utilisateu

32、r ISO/IEC 26513:2009(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 licensed to and installed on the computer performing the editing. In

33、 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 the software products used to create this PDF file can be found i

34、n 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 relating to it is found, please inform the Central Secretariat at the add

35、ress given below. COPYRIGHT PROTECTED DOCUMENT ISO/IEC 2009 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 photocopying and microfilm, without permission in writing from eithe

36、r ISO at the address below or ISOs member body in the country of the requester. ISO copyright office Case postale 56 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 in Switzerland ii ISO/IEC 2009 All rights reservedISO/IEC 26513:2009(E

37、) ISO/IEC 2009 All rights reserved iiiContents Page Foreword iv Introduction.v 1 Scope1 2 Conformance .2 2.1 Definition of conformance2 2.2 Conformance situations .3 3 Terms and definitions .3 4 User documentation process within the systems/software life cycle .8 5 Documentation evaluation process r

38、equirements, objectives, and constraints9 5.1 General .9 5.2 Documentation evaluation activities .10 5.3 Selection of an evaluation method 10 5.4 Documentation review 10 5.5 Documentation test .11 5.6 Project requirements affecting documentation evaluation.11 5.7 Resource requirements and planning.1

39、2 5.7.1 Impact of evaluation on project schedules.13 6 Documentation evaluation methods and procedures .13 6.1 Documentation review 14 6.1.1 Planning documentation review 14 6.1.2 Documentation review procedures .16 6.1.3 Managing the results of documentation review.17 6.1.4 Problem resolution and t

40、he documentation review cycle.17 6.2 System test of documentation .17 6.2.1 Planning system test of documentation .18 6.2.2 Performing and assessing results of system test of documentation22 6.2.3 Problem resolution and the system test of documentation life cycle .22 6.3 Usability testing of documen

41、tation .22 6.3.1 Objectives for usability testing of documentation.23 6.3.2 Measures and metrics for documentation usability testing .23 6.3.3 Planning usability tests 24 6.3.4 Performing usability test of documentation.26 6.3.5 Problem resolution for documentation usability tests27 6.4 Accessibilit

42、y testing of documentation 27 6.4.1 Planning accessibility tests27 6.4.2 Performing accessibility tests .28 6.5 Localization and customization testing 28 6.5.1 Planning for localization and customization testing .28 6.5.2 Performing localization and customization testing .28 6.6 Problem resolution p

43、rocess.29 Annex A (informative) Checklists for user documentation 30 Annex B (informative) Test and review checklist 37 Bibliography53 ISO/IEC 26513:2009(E) iv ISO/IEC 2009 All rights reservedForeword ISO (the International Organization for Standardization) and IEC (the International Electrotechnica

44、l Commission) form the specialized system for worldwide standardization. National bodies that are members of ISO or IEC participate in the development of International Standards through technical committees established by the respective organization to deal with particular fields of technical activi

45、ty. ISO and IEC technical committees collaborate in fields of mutual interest. Other international organizations, governmental and non-governmental, in liaison with ISO and IEC, also take part in the work. In the field of information technology, ISO and IEC have established a joint technical committ

46、ee, ISO/IEC JTC 1. International Standards are drafted in accordance with the rules given in the ISO/IEC Directives, Part 2. The main task of the joint technical committee is to prepare International Standards. Draft International Standards adopted by the joint technical committee are circulated to

47、national bodies for voting. Publication as an International Standard requires approval by at least 75 % of the national bodies casting a vote. Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. ISO and IEC shall not be held responsib

48、le for identifying any or all such patent rights. ISO/IEC 26513 was prepared by Joint Technical Committee ISO/IEC JTC 1, Information technology, Subcommittee SC 7, Software and systems engineering. ISO/IEC 26513:2009(E) ISO/IEC 2009 All rights reserved vIntroduction Anyone who uses application softw

49、are needs accurate information about how the software will help the users accomplish a task. The documentation might be the first tangible item that the users see, and so influences the first impressions the users have of the product. If the information is supplied in a convenient form and is easy to find and understand, the users can quickly become proficient at using the product. Therefore, well-designed documentation not only assists the users and helps to reduce the cost of training and support, but also enhances the reputation o