BS ISO IEC 26511-2012 Systems and software engineering Requirements for managers of user documentation《系统和软件工程 用户文档管理要求》.pdf

1、raising standards worldwide NO COPYING WITHOUT BSI PERMISSION EXCEPT AS PERMITTED BY COPYRIGHT LAW BSI Standards Publication BS ISO/IEC 26511:2011 Systems and software engineering Requirements for managers of user documentationBS ISO/IEC 26511:2011 BRITISH STANDARD National foreword This British Sta

2、ndard is the UK implementation of ISO/IEC 26511:2011. It supersedes PD ISO/IEC TR 9294:2005, which is withdrawn. The UK participation in its preparation was entrusted to Technical Committee IST/15, Software and systems engineering. A list of organizations represented on this committee can be obtaine

3、d on request to its secretary. This publication does not purport to include all the necessary provisions of a contract. Users are responsible for its correct application. The British Standards Institution 2012 Published by BSI Standards Limited 2012 ISBN 978 0 580 68058 8 ICS 35.080 Compliance with

4、a British Standard cannot confer immunity from legal obligations. This British Standard was published under the authority of the Standards Policy and Strategy Committee on 31 March 2012. Amendments issued since publication Date Text affectedBS ISO/IEC 26511:2011Reference number ISO/IEC 26511:2011(E)

5、 ISO/IEC 2011INTERNATIONAL STANDARD ISO/IEC 26511 First edition 2011-12-01 Systems and software engineering Requirements for managers of user documentation Ingnierie des systmes et du logiciel Exigences pour les gestionnaires de la documentation dutilisation BS ISO/IEC 26511:2011 ISO/IEC 26511:2011(

6、E) COPYRIGHT PROTECTED DOCUMENT ISO/IEC 2011 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 either ISO at the ad

7、dress 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 2011 All rights reservedBS ISO/IEC 26511:2011 ISO/IEC 26511

8、:2011(E) ISO/IEC 2011 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 cycle processes 6 5.1 Us

9、er 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 Planning for user document

10、ation 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 documentation management pl

11、an 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.1 Definition of roles

12、 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 measurements 26 9.1.4

13、 Process improvement measurements 27 9.2 Documentation estimating . 27 10 Applying management control to documentation . 28 10.1 Purpose and outcomes . 28 10.2 Change management 29 10.3 Schedule and cost control . 29 10.4 Resource management . 30 10.4.1 Project communication . 30 10.4.2 Managing doc

14、umentation team members and suppliers 30 10.4.3 Managing translation services . 30 10.5 Quality management . 31 BS ISO/IEC 26511:2011 ISO/IEC 26511:2011(E) iv ISO/IEC 2011 All rights reserved10.5.1 Managing for product qualityreviews and tests .31 10.5.2 Risk and problem management .31 10.5.3 Proces

15、s improvement .32 Annex A (informative) Sample documentation plan .33 Annex B (normative) Information Management and Software Documentation Management Processes .41 Bibliography 45 BS ISO/IEC 26511:2011 ISO/IEC 26511:2011(E) ISO/IEC 2011 All rights reserved vForeword ISO (the International Organizat

16、ion 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 technical committees established by the respect

17、ive 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 part in the work. In the field of information

18、 technology, ISO and IEC have established a joint technical committee, 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 St

19、andards adopted by the joint technical committee are circulated to 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 th

20、e subject of patent rights. ISO and IEC shall not be held responsible for identifying any or all such patent rights. ISO/IEC 26511 was prepared by Joint Technical Committee ISO/IEC JTC 1, Information technology, Subcommittee SC 7, Software and systems engineering. This first edition of ISO/IEC 26511

21、 cancels and replaces ISO/IEC TR 9294:2005, which has been technically revised. BS ISO/IEC 26511:2011 ISO/IEC 26511:2011(E) vi ISO/IEC 2011 All rights reservedIntroduction Effective management of the software user documentation tasks is essential in order to ensure that documentation is usable, accu

22、rate, delivered when needed by the users, produced efficiently, 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 u

23、ses application software needs accurate information about 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

24、 form and is easy to find and understand, the users can quickly 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

25、suppliers. Although many software designers aim to have user 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 regarde

26、d as something done after the software has been implemented. 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

27、is a big enough job to require process planning in its own 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 en

28、gineering Software life cycle processes, to manage software 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 documentati

29、on management. NOTE: Other International Standards in the ISO/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

30、 organizations producing suites of documentation, to those undertaking 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 doc

31、umentation for a single software product, it applies to a broader 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 a

32、nd reuse of information (content management) for: multiple updates of user documentation as the software version is updated; multiple reuses or adaptations of information to support related software products; multiple translated or localized versions of user documentation; a portfolio of unrelated d

33、ocumentation projects being managed concurrently 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 pro

34、ject management tools or protocols. The 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. BS ISO/IEC 26511:2011 INTERNATIONAL STANDARD ISO/IEC 26511:2011(E

35、) ISO/IEC 2011 All rights reserved 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,

36、 performance, and control for 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 pla

37、ns. This International Standard 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. Specifica

38、lly, it addresses the following: 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;

39、the application of management 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,

40、 preparing, and testing user 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-2

41、010, IEEE Standard for Adoption 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 2651

42、3-2010, IEEE Standard for Adoption 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 S

43、tandard is applicable for use 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 developm

44、ent process; acquirers of documentation prepared by suppliers; experienced writers who develop the written content for user documentation; developers of tools for creating on-screen documentation; BS ISO/IEC 26511:2011 ISO/IEC 26511:2011(E) 2 ISO/IEC 2011 All rights reserved human-factors experts wh

45、o identify principles 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 app

46、lied 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 design and development, based on reuse of user documentation topics; documentation of products other than

47、 software; multimedia marketing presentations using animation, video, and sound; computer-based training (CBT) packages and specialized course materials intended primarily for use in formal training programs; maintenance documentation describing the internal operation of systems software. NOTE 2: IS

48、O/IEC/IEEE 15289:2011 provides more detailed content for life-cycle process information items (documentation). 2 Conformance 2.1 Definition of conformance This International Standard may be used as a conformance document for projects and organizations claiming conformance to ISO/IEC 15288:2008 (IEEE

49、 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. This International Standard is meant to be tailored so that only necessary and cost-effective requirements are applied to documentation. Tailoring may take the form of specifying approaches to conform to