IEEE 26512-2011 en Systems and software engineering Requirements for acquirers and suppliers of user documentation (IEEE Computer Society).pdf

1、 Reference numberISO/IEC/IEEE 26512:2011(E)ISO/IEC 2011IEEE 2011INTERNATIONAL STANDARD ISO/IEC/IEEE26512First edition2011-06-01Systems and software engineering Requirements for acquirers and suppliers of user documentation Ingnierie du logiciel et des systmes Exigences pour acqureurs et fournisseurs

2、 de documentation utilisateur ISO/IEC/IEEE 26512:2011(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 co

3、mputer performing the editing. In downloading this file, parties accept therein the responsibility of not infringing Adobes licensing policy. The ISO Central Secretariat, the IEC Central Office and IEEE do not accept any liability in this area. Adobe is a trademark of Adobe Systems Incorporated. Det

4、ails of 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 and IEEE members. In the unlikely even

5、t that a problem relating to it is found, please inform the ISO Central Secretariat or IEEE at the address given below. COPYRIGHT PROTECTED DOCUMENT ISO/IEC 2011 IEEE 2011 All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized in any form or by any

6、 means, electronic or mechanical, including photocopying 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,

7、 New York CH-1211 Geneva 20 CH-1211 Geneva 20 NY 10016-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 2011 All rights reserved I

8、EEE 2011 All rights reservedISO/IEC/IEEE 26512:2011(E) ISO/IEC 2011 All rights reserved IEEE 2011 All rights reserved iiiContents Page Foreword .v Introductionvi 1 Scope1 2 Conformance .2 2.1 Definition of conformance2 2.2 Conformance situations .3 3 Normative references3 4 Terms and definitions .3

9、5 User documentation within a system/software life cycle8 5.1 Software documentation management process 8 5.2 Information management process.9 6 User documentation agreement processes within a system/software life cycle .10 6.1 User documentation acquisition process.10 6.1.1 Purpose of the acquisiti

10、on process 10 6.1.2 Outcomes of the acquisition process .11 6.2 User documentation acquisition activities and tasks .11 6.2.1 Acquisition preparation 11 6.2.2 Supplier selection13 6.2.3 Contract agreement.13 6.2.4 Contract management and monitoring .13 6.2.5 Acquirer acceptance .14 6.2.6 Acquisition

11、 closure .14 6.3 User documentation supply process 14 6.3.1 Purpose of the supply process14 6.3.2 Outcomes of the supply process.14 6.4 User documentation supply activities and tasks.14 6.4.1 Opportunity identification and evaluation 15 6.4.2 Proposal preparation 15 6.4.3 Contract agreement.15 6.4.4

12、 Contract execution 15 6.4.5 Product/service delivery and support.17 6.4.6 Closure .17 7 Defining user documentation requirements and constraints.18 7.1 Aspects of requirements and constraints 18 7.2 Schedule constraints 18 7.3 Usability requirements19 7.4 Product modification requirements.19 7.5 Lo

13、calization and translation requirements.20 7.6 Legal requirements .20 7.7 Security requirements.21 7.8 Standards and conventions .21 7.9 Quality management requirements .21 8 User Documentation Specification21 9 User documentation Statement of Work.22 10 Request for Proposal 23 10.1 Request for Prop

14、osal topics 23 10.2 Project objectives23 ISO/IEC/IEEE 26512:2011(E) iv ISO/IEC 2011 All rights reserved IEEE 2011 All rights reserved10.3 Requirements for supporting processes 24 10.4 Supplier capabilities and experience.24 10.5 Instructions for bidders 24 10.6 List of deliverable user documentation

15、 products or services 24 10.7 Terms and conditions .25 10.8 Proposal evaluation criteria25 11 Documentation proposal 25 11.1 Documentation proposal contents 25 11.2 Understanding of requirements .26 11.3 Scope of the project 26 11.4 Processes .27 11.5 Experience, capabilities, and available resource

16、s.27 11.6 Schedule .28 11.7 Deliverables28 11.8 Price proposal28 Annex A (informative) Requirements clauses and checklist for acquirers.29 Annex B (informative) Requirements clauses and checklist for suppliers.34 Bibliography 37 ISO/IEC/IEEE 26512:2011(E) ISO/IEC 2011 All rights reserved IEEE 2011 A

17、ll rights reserved 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 Stan

18、dards through technical 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

19、 IEC, also take 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) St

20、andards Board. 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 Ins

21、titute and serve 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 Sta

22、ndards are drafted 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 Intern

23、ational Standard 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

24、 the existence 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 an

25、y licensing terms 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 va

26、lidity of any patent 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 26512:2011 was prepared by Joint Technical Committee ISO/IEC JTC 1, Information technology, Sub

27、committee SC 7, Software and systems engineering, in cooperation with the Software and Systems Engineering Standards 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 26512 cance

28、ls and replaces ISO/IEC 15910:1999, which has been technically revised. ISO/IEC/IEEE 26512:2011(E) vi ISO/IEC 2011 All rights reserved IEEE 2011 All rights reservedIntroduction This International Standard was developed to assist users of ISO/IEC 15288:2008 (IEEE Std 15288-2008) or ISO/IEC 12207:2008

29、 (IEEE Std 12207-2008) to acquire or supply software user documentation and documentation services as part of the software life cycle processes. It defines the documentation process from the acquirers standpoint and the suppliers standpoint. The accurate description of the requirements for user docu

30、mentation is essential in order to ensure that the documentation meets the needs of its users. This International Standard addresses the identification, definition, and fulfillment of user documentation requirements as part of the acquisition and supply processes. This International Standard covers

31、the requirements for information items used in the acquisition of user documentation products: the Acquisition Plan, Document Specification, Statement of Work, Request for Proposals, and the Proposal. It also discusses the use of a Documentation Management Plan and a Document Plan as they arise in t

32、he acquisition and supply processes. This International Standard is independent of the software tools that can be used to produce documentation, and applies to both printed documentation and on-screen documentation. Much of its guidance is applicable to user documentation for systems including hardw

33、are as well as software. Earlier standards tended to view the results of the documentation process as a single book or multi-volume set: a one-time deliverable. Increasingly, documentation acquirers and suppliers recognize that most user documentation is now produced from managed re-use of previousl

34、y developed information (single-source documentation) adapted for new software versions, or presentation in various on-screen and printed media. While this International Standard does not describe how to set up a content management system, it is applicable for documentation organizations practising

35、single-source documentation, as well as for acquirers and suppliers of one-time deliverables. Anyone who uses 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 so influ

36、ences the users first impressions of the software product. If the information is supplied in a convenient form and is easy to find and understand, the user can quickly become proficient at using the product. Therefore, well-designed documentation not only assists the user and helps to reduce the cos

37、t of training and support, but also enhances the reputation of the product, its producer, and its suppliers. Although software developers intend to design user interfaces that behave so intuitively that very little separate documentation is needed, this is rarely possible. Todays software offers inc

38、reasingly robust functionality, not only within applications, but also across applications which intelligently exchange information with one another. Further, most software includes underlying rules and calculations, or algorithms that affect the results a user can obtain when using the software. Th

39、ese underlying programming mechanics are discernable by users, but only through laborious testing. For these and other reasons, user documentation remains an essential component of usable software products. Documentation is often regarded as something done after the software has been implemented. Ho

40、wever, for high-quality software documentation, its development needs to be regarded as an integral part of the software life cycle. In fact, quality documentation or information management services are important enough to require specific planning. Related standards for those acquiring and supplyin

41、g software user documentation include ISO/IEC 26514:2008 (IEEE Std 26514-2010), Systems and software engineering Requirements for designers and developers of user documentation, and ISO/IEC 26513:2009 (IEEE Std 26513-2010), Systems and software engineering Requirements for testers and reviewers of u

42、ser documentation. Other International Standards are in preparation or planned to address the documentation and information management processes from the viewpoint of managers and agile projects. ISO/IEC/IEEE 26512:2011(E) ISO/IEC 2011 All rights reserved IEEE 2011 All rights reserved viiThis Intern

43、ational Standard is consistent with ISO/IEC 12207:2008 (IEEE Std 12207-2008) as an implementation of the Acquisition and Supply processes, which comprise the Agreement processes, and of the Information Management and Software Documentation Management Processes. This International Standard is intende

44、d for use in all types of organizations, whether they have a dedicated documentation department or not. It can be used as a basis for local standards and procedures. Readers are assumed to have experience or knowledge of general agreement processes for acquisition and supply of products and services

45、. The order of clauses in this International Standard does not imply that the acquisition activities need to be performed in this order, nor that documentation needs to be developed in this order or presented to the user in this order. In each clause, the requirements are media-independent, as far a

46、s possible. The checklists in Annexes A and B can be used to track conformance with the requirements of this International Standard for acquirers and suppliers of documentation products. The Bibliography contains references to source material used in the development of this International Standard, a

47、s well as sources of additional information that might be useful to acquirers and suppliers. INTERNATIONAL STANDARD ISO/IEC/IEEE 26512:2011(E) ISO/IEC 2011 All rights reserved IEEE 2011 All rights reserved 1Systems and software engineering Requirements for acquirers and suppliers of user documentati

48、on 1 Scope This International Standard supports the interest of software users in having consistent, complete, accurate, and usable documentation. It addresses both available approaches to standardization: a) process standards, which specify the way that documentation products are to be acquired and

49、 supplied; and b) documentation product standards, which specify the characteristics and functional requirements of the documentation. As defined in ISO/IEC 12207:2008 (IEEE Std 12207-2008) and ISO/IEC 15288:2008 (IEEE Std 15288-2008), the acquisition and supply activities comprise the agreement processes of the software life cycle. Acquisition and supply of user documentation and user documentation services are specializations of those processes. User documentation services can be acquired and supplied for any