1、 Reference numberISO/IEC/IEEE 26511:2012(E)ISO/IEC 2012IEEE 2012INTERNATIONAL STANDARD ISO/IEC/IEEE26511First edition2011-12-01Corrected version2012-03-15Systems and software engineering Requirements for managers of user documentation Ingnierie des systmes et du logiciel Exigences pour les gestionna
2、ires de la documentation dutilisation ISO/IEC/IEEE 26511:2012(E) COPYRIGHT PROTECTED DOCUMENT ISO/IEC 2012 IEEE 2012 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 photocopyin
3、g and microfilm, without permission in writing from ISO, IEC or IEEE at the respective address below. ISO copyright office IEC Central Office Institute of Electrical and Electronics Engineers, Inc. Case postale 56 3, rue de Varemb 3 Park Avenue, New York CH-1211 Geneva 20 CH-1211 Geneva 20 NY 10016-
4、5997, USA Tel. + 41 22 749 01 11 Switzerland E-mail stds.iprieee.org Fax + 41 22 749 09 47 E-mail inmailiec.ch Web www.ieee.org E-mail copyrightiso.org Web www.iec.ch Web www.iso.org Published in Switzerland ii ISO/IEC 2012 All rights reserved IEEE 2012 All rights reservedISO/IEC/IEEE 26511:2012(E)
5、ISO/IEC 2012 All rights reserved IEEE 2012 All rights reserved iiiContents Page Foreword . v Introduction vi 1 Scope 1 2 Conformance . 2 2.1 Definition of conformance 2 2.2 Conformance situations . 2 3 Normative references 3 4 Terms and definitions . 3 5 User documentation management within life cyc
6、le processes 6 5.1 User documentation management within the software life cycle 6 5.2 Portfolio management and content management 8 5.3 Information management strategy and policies 8 6 Planning in documentation management . 10 6.1 Work breakdown structures for documentation management . 10 6.2 Plann
7、ing for user documentation 11 6.2.1 Determination of purpose and audience . 12 6.2.2 Design tasks 13 6.2.3 Development tasks 13 6.2.4 Translation and localization tasks . 14 6.2.5 Production tasks . 14 6.2.6 Change management and maintenance tasks . 14 7 User documentation plans . 15 7.1 User docume
8、ntation management plan compared to documentation plan 15 7.2 Contents of the documentation management plan . 16 7.3 Contents of the documentation plan . 16 8 Project activation . 17 8.1 Authorization, procedures, and specifications 17 8.2 Infrastructure . 18 8.3 Information development team 19 8.3.
9、1 Definition of roles 19 8.3.2 Example roles for user documentation . 20 9 User documentation management control methods . 24 9.1 Documentation measurements 24 9.1.1 User documentation product measurements . 25 9.1.2 User documentation productivity measurements . 26 9.1.3 User documentation quality
10、measurements 26 9.1.4 Process improvement measurements 27 9.2 Documentation estimating . 27 10 Applying management control to documentation . 29 10.1 Purpose and outcomes . 29 10.2 Change management 29 10.3 Schedule and cost control . 29 10.4 Resource management . 30 10.4.1 Project communication . 3
11、0 10.4.2 Managing documentation team members and suppliers 30 10.4.3 Managing translation services . 30 ISO/IEC/IEEE 26511:2012(E) iv ISO/IEC 2012 All rights reserved IEEE 2012 All rights reserved10.5 Quality management .31 10.5.1 Managing for product qualityreviews and tests .31 10.5.2 Risk and pro
12、blem management .31 10.5.3 Process improvement .32 Annex A (informative) Sample documentation plan .33 Annex B (normative) Information Management and Software Documentation Management Processes .41 Bibliography 45 ISO/IEC/IEEE 26511:2012(E) ISO/IEC 2012 All rights reserved IEEE 2012 All rights reser
13、ved vForeword ISO (the International Organization for Standardization) and IEC (the International Electrotechnical 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 t
14、echnical committees established by the respective organization to deal with particular fields of technical activity. 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
15、 part in the work. In the field of information technology, ISO and IEC have established a joint technical committee, ISO/IEC JTC 1. IEEE Standards documents are developed within the IEEE Societies and the Standards Coordinating Committees of the IEEE Standards Association (IEEE-SA) Standards Board.
16、The IEEE develops its standards through a consensus development process, approved by the American National Standards Institute, which brings together volunteers representing varied viewpoints and interests to achieve the final product. Volunteers are not necessarily members of the Institute and serv
17、e without compensation. While the IEEE administers the process and establishes rules to promote fairness in the consensus development process, the IEEE does not independently evaluate, test, or verify the accuracy of any of the information contained in its standards. International Standards are draf
18、ted in accordance with the rules given in the ISO/IEC Directives, Part 2. The main task of ISO/IEC JTC 1 is to prepare International Standards. Draft International Standards adopted by the joint technical committee are circulated to national bodies for voting. Publication as an International Standar
19、d requires approval by at least 75 % of the national bodies casting a vote. Attention is called to the possibility that implementation of this standard may require the use of subject matter covered by patent rights. By publication of this standard, no position is taken with respect to the existence
20、or validity of any patent rights in connection therewith. ISO/IEEE is not responsible for identifying essential patents or patent claims for which a license may be required, for conducting inquiries into the legal validity or scope of patents or patent claims or determining whether any licensing ter
21、ms or conditions provided in connection with submission of a Letter of Assurance or a Patent Statement and Licensing Declaration Form, if any, or in any licensing agreements are reasonable or non-discriminatory. Users of this standard are expressly advised that determination of the validity of any p
22、atent rights, and the risk of infringement of such rights, is entirely their own responsibility. Further information may be obtained from ISO or the IEEE Standards Association. ISO/IEC/IEEE 26511 was prepared by Joint Technical Committee ISO/IEC JTC 1, Information technology, Subcommittee SC 7, Soft
23、ware and systems engineering, in cooperation with the Systems and Software Engineering Committee of the IEEE Computer Society, under the Partner Standards Development Organization cooperation agreement between ISO and IEEE. This first edition of ISO/IEC/IEEE 26511 cancels and replaces ISO/IEC TR 929
24、4:2005, which has been technically revised. In this corrected version, the cover pages, front matter, page headers and footers have been corrected to reflect that ISO/IEC/IEEE 26511 is a joint development project under the Partner Standards Development Organization cooperation agreement between ISO
25、and IEEE. ISO/IEC/IEEE 26511:2012(E) vi ISO/IEC 2012 All rights reserved IEEE 2012 All rights reservedIntroduction Effective management of the software user documentation tasks is essential in order to ensure that documentation is usable, accurate, delivered when needed by the users, produced effici
26、ently, and maintained consistent with the software. This International Standard addresses the management of user documentation in relation to both initial development and subsequent releases of the software and user documentation. Anyone who uses application software needs accurate information about
27、 how the software will help the user accomplish a task. The documentation can be the first tangible item that the user sees, and if so, it can influence the users first impressions of the product. If the information is supplied in a convenient form and is easy to find and understand, the users can q
28、uickly become proficient at using the product. Hence, a well-managed documentation process 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. Although many software designers aim to have us
29、er interfaces that behave so intuitively that very little separate documentation is needed, this approach is rarely possible in practice. User documentation is an essential component of usable software products. Documentation is often regarded as something done after the software has been implemente
30、d. However, for quality software documentation, its development should be regarded as an integral part of the software life-cycle process from the planning and design stages onwards. If done properly, documentation or information management is a big enough job to require process planning in its own
31、right. This International Standard was developed to assist users of ISO/IEC 15288:2008 (IEEE Std 15288-2008), Systems and software engineering System life cycle processes, or ISO/IEC 12207:2008 (IEEE Std 12207-2008), Systems and software engineering Software life cycle processes, to manage software
32、user documentation as part of the software life cycle. This International Standard defines the documentation process from the managers standpoint. It was developed to assist those who provide input to, perform, and evaluate user documentation management. NOTE: Other International Standards in the IS
33、O/IEC 265NN family address the documentation and information management processes from the viewpoint of documentation designers/developers, testers and reviewers, and acquirers and suppliers. This International Standard applies to people or organizations producing suites of documentation, to those u
34、ndertaking a single documentation project, and for documentation produced internally as well as to documentation contracted to outside service organizations. Beyond the development and production of a user manual, help system, or set of documentation for a single software product, it applies to a br
35、oader range of documentation management situations, including user documentation for those who install, implement, administer, and operate software for end users. Frequently, user documentation managers are responsible for the development and reuse of information (content management) for: g120 multi
36、ple updates of user documentation as the software version is updated; g120 multiple reuses or adaptations of information to support related software products; g120 multiple translated or localized versions of user documentation; g120 a portfolio of unrelated documentation projects being managed conc
37、urrently within an organization. This International Standard is not intended to advocate the use of either printed or electronic (on-screen) media for documentation, or of any particular information management, content management, documentation testing, or project management tools or protocols. The
38、requirements are media-independent, as far as possible. This International Standard may be applied to user documentation for systems including software as well as to software user documentation. INTERNATIONAL STANDARD ISO/IEC/IEEE 26511:2012(E) ISO/IEC 2012 All rights reserved IEEE 2012 All rights r
39、eserved 1Systems and software engineering Requirements for managers of user documentation 1 Scope This International Standard supports the needs of software users for consistent, complete, accurate, and usable documentation. It provides requirements for strategy, planning, performance, and control f
40、or documentation managers. It specifies procedures for managing user documentation throughout the software life cycle. It also includes requirements for key documents produced for user documentation management, including documentation plans and documentation management plans. This International Stan
41、dard provides an overview of the software documentation and information management processes which are specialized for user documentation in this International Standard. It also presents aspects of portfolio planning and content management for user documentation. Specifically, it addresses the follo
42、wing: management requirements in starting a project, including setting up procedures and specifications, establishing infrastructure, and building a team, with examples of roles needed on a user documentation team; measurements and estimates needed for management control; the application of manageme
43、nt control to user documentation work; the use of supporting processes such as change management, schedule and cost control, resource management, quality management and process improvement. The works listed in the Bibliography provide guidance on the processes of managing, preparing, and testing use
44、r documentation. NOTE 1: Related standards of value to documentation managers and others involved in the process include ISO/IEC 26514:2008, Systems and software engineering Requirements for designers and developers of user documentation (also available as IEEE Std 26514-2010, IEEE Standard for Adop
45、tion of ISO/IEC 26514:2008, Systems and Software Engineering Requirements for Designers and Developers of User Documentation); ISO/IEC 26513:2009, Systems and software engineering Requirements for testers and reviewers of user documentation (also available as IEEE Std 26513-2010, IEEE Standard for A
46、doption of ISO/IEC 26513:2009, Systems and Software Engineering Requirements for Testers and Reviewers of User Documentation); and ISO/IEC/IEEE 26512:2011, Systems and software engineering Requirements for acquirers and suppliers of user documentation. This International Standard is applicable for u
47、se by managers of user documentation projects or organizations with information designers and documentation developers. This International Standard may also be consulted by those with other roles and interests in the documentation process: managers of the software development process; acquirers of d
48、ocumentation prepared by suppliers; experienced writers who develop the written content for user documentation; developers of tools for creating on-screen documentation; ISO/IEC/IEEE 26511:2012(E) 2 ISO/IEC 2012 All rights reserved IEEE 2012 All rights reserved human-factors experts who identify pri
49、nciples for making documentation more accessible and easily used; graphic designers with expertise in electronic media; user interface designers and ergonomics experts working together to design the presentation of the documentation on the screen. This International Standard may be applied to manage the following types of documentation, although it does not cover all aspects of them: documentation for user assistance, training, marketing, and systems documentation for product desig
