CAN CSA-ISO IEC 6592-2004 Information technology-Guidelines for the documentation of computer-based application systems.pdf

1、Reference numberISO/IEC 6592:2000(E)ISO/IEC 2000InformationtechnologyGuidelinesforthe documentation of computer-basedapplication systemsTechnologies de linformation Principes gnraux relatifs ladocumentation des systmes dapplication informatissNational Standard of CanadaCAN/CSA-ISO/IEC 6592:04(ISO/IE

2、C 6592:2000)International Standard ISO/IEC 6592:2000 (first edition, 2000-03-15) has been adopted withoutmodification (IDT) as CSA Standard CAN/CSA-ISO/IEC 6592:04, which has been approved as a NationalStandard of Canada by the Standards Council of Canada.ISBN 1-55397-719-X December 2004The Canadian

3、 Standards Association (CSA), under whose auspices this National Standard has been produced, was chartered in 1919 and accredited by the Standards Council of Canada to the National Standards system in 1973. It is a not-for-profit, nonstatutory, voluntary membership association engaged in standards d

4、evelopment and certification activities. CSA standards reflect a national consensus of producers and users including manufacturers, consumers, retailers, unions and professional organizations, and governmental agencies. The standards are used widely by industry and commerce and often adopted by muni

5、cipal, provincial, and federal governments in their regulations, particularly in the fields of health, safety, building and construction, and the environment. Individuals, companies, and associations across Canada indicate their support for CSAs standards development by volunteering their time and s

6、kills to CSA Committee work and supporting the Associations objectives through sustaining memberships. The more than 7000 committee volunteers and the 2000 sustaining memberships together form CSAs total membership from which its Directors are chosen. Sustaining memberships represent a major source

7、of income for CSAs standards development activities. The Association offers certification and testing services in support of and as an extension to its standards development activities. To ensure the integrity of its certification process, the Association regularly and continually audits and inspect

8、s products that bear the CSA Mark. In addition to its head office and laboratory complex in Toronto, CSA has regional branch offices in major centres across Canada and inspection and testing agencies in eight countries. Since 1919, the Association has developed the necessary expertise to meet its co

9、rporate mission: CSA is an independent service organization whose mission is to provide an open and effective forum for activities facilitating the exchange of goods and services through the use of standards, certification and related services to meet national and international needs.For further inf

10、ormation on CSA services, write toCanadian Standards Association5060 Spectrum Way, Suite 100Mississauga, Ontario, L4W 5N6CanadaThe Standards Council of Canada is the coordinating body of the National Standards system, a federation of independent, autonomous organizations working towards the further

11、development and improvement of voluntary standardization in the national interest. The principal objects of the Council are to foster and promote voluntary standardization as a means of advancing the national economy, benefiting the health, safety, and welfare of the public, assisting and protecting

12、 the consumer, facilitating domestic and international trade, and furthering international cooperation in the field of standards. A National Standard of Canada is a standard which has been approved by the Standards Council of Canada and one which reflects a reasonable agreement among the views of a

13、number of capable individuals whose collective interests provide to the greatest practicable extent a balance of representation of producers, users, consumers, and others with relevant interests, as may be appropriate to the subject in hand. It normally is a standard which is capable of making a sig

14、nificant and timely contribution to the national interest. Approval of a standard as a National Standard of Canada indicates that a standard conforms to the criteria and procedures established by the Standards Council of Canada. Approval does not refer to the technical content of the standard; this

15、remains the continuing responsibility of the accredited standards development organization. Those who have a need to apply standards are encouraged to use National Standards of Canada whenever practicable. These standards are subject to periodic review; therefore, users are cautioned to obtain the l

16、atest edition from the organization preparing the standard.The responsibility for approving National Standards of Canada rests with theStandards Council of Canada270 Albert Street, Suite 200Ottawa, Ontario, K1P 6N7CanadaAlthough the intended primary application of this Standard is stated in its Scop

17、e, it is importantto note that it remains the responsibility of the users to judge its suitability for their particular purpose.Registered trade-mark of Canadian Standards AssociationCAN/CSA-ISO/IEC 6592:04Information technology Guidelines for thedocumentation of computer-based application systemsDe

18、cember 2004 Canadian Standards Association CSA/1CAN/CSA-ISO/IEC 6592:04Information technology Guidelines for the documentation of computer-based application systemsCSA PrefaceStandards development within the Information Technology sector is harmonized with international standards development. Throug

19、h the CSA Technical Committee on Information Technology (TCIT), Canadians serve as the Canadian Advisory Committee (CAC) on ISO/IEC Joint Technical Committee 1 on Information Technology (ISO/IEC JTC1) for the Standards Council of Canada (SCC), the ISO member body for Canada and sponsor of the Canadi

20、an National Committee of the IEC. Also, as a member of the International Telecommunication Union (ITU), Canada participates in the International Telegraph and Telephone Consultative Committee (ITU-T).This International Standard was reviewed by the CSA TCIT under the jurisdiction of the Strategic Ste

21、ering Committee on Information Technology and deemed acceptable for use in Canada. (A committee membership list is available on request from the CSA Project Manager.) From time to time, ISO/IEC may publish addenda, corrigenda, etc. The CSA TCIT will review these documents for approval and publicatio

22、n. For a listing, refer to the CSA Information Products catalogue or CSA Info Update or contact a CSA Sales representative. This Standard has been formally approved as a National Standard of Canada by the Standards Council of Canada.December 2004 Canadian Standards Association 2004All rights reserve

23、d. No part of this publication may be reproduced in any form whatsoever without the prior permission ofthe publisher. ISO/IEC material is reprinted with permission. Where the words “this International Standard” appear in the text, they should be interpreted as “this National Standard of Canada”.Inqu

24、iries regarding this National Standard of Canada should be addressed toCanadian Standards Association5060 Spectrum Way, Suite 100, Mississauga, Ontario, Canada L4W 5N61-800-463-6727 416-747-4044www.csa.caReference numberISO/IEC 6592:2000(E)ISO/IEC 2000INTERNATIONALSTANDARDISO/IEC6592First edition200

25、0-03-15Information technology Guidelines forthe documentation of computer-basedapplication systemsTechnologies de linformation Principes gnraux relatifs ladocumentation des systmes dapplication informatissISO/IEC 6592:2000(E)PDF disclaimerThis PDF file may contain embedded typefaces. In accordance w

26、ith Adobes licensing policy, this file may be printed or viewed but shall notbe edited unless the typefaces which are embedded are licensed to and installed on the computer performing the editing. In downloading thisfile, parties accept therein the responsibility of not infringing Adobes licensing p

27、olicy. The ISO Central Secretariat accepts no liability in thisarea.Adobe is a trademark of Adobe Systems Incorporated.Details of the software products used to create this PDF file can be found in the General Info relative to the file; the PDF-creation parameterswere optimized for printing. Every ca

28、re has been taken to ensure that the file is suitable for use by ISO member bodies. In the unlikely eventthat a problem relating to it is found, please inform the Central Secretariat at the address given below. ISO/IEC 2000All rights reserved. Unless otherwise specified, no part of this publication

29、may be reproduced or utilized in any form or by any means, electronicor mechanical, including photocopying and microfilm, without permission in writing from either ISO at the address below or ISOs member bodyin the country of the requester.ISO copyright officeCase postale 56 Gb7 CH-1211 Geneva 20Tel

30、. + 41 22 749 01 11Fax + 41 22 734 10 79E-mail copyrightiso.chWeb www.iso.chii ISO/IEC 2000 All rights reservedISO/IEC 6592:2000(E) ISO/IEC 2000 All rights reservediiiContents Page1 Scope12 Normative references .23 Terms and definitions.24 Use of this International Standard 24.1 Purpose of documenta

31、tion.34.2 Principles of documentation34.3 Application of this International Standard to a software system.34.3.1 General application.34.3.2 Specification of document contents.44.3.3 Review of existing document contents 44.4 Constraints44.5 Customization .55 Documentation method55.1 Overview of the d

32、escription of information items.55.2 Documentation profile55.3 Description of information items.55.4 Detailed description of information items11Annex A (informative) Example of a documentation profile28Bibliography31ISO/IEC 6592:2000(E)iv ISO/IEC 2000 All rights reservedForewordISO (the Internationa

33、l Organization for Standardization) and IEC (the International Electrotechnical Commission)form the specialized system for worldwide standardization. National bodies that are members of ISO or IECparticipate in the development of International Standards through technical committees established by th

34、erespective organization to deal with particular fields of technical activity. ISO and IEC technical committeescollaborate in fields of mutual interest. Other international organizations, governmental and non-governmental, inliaison with ISO and IEC, also take part in the work.International Standard

35、s are drafted in accordance with the rules given in the ISO/IEC Directives, Part 3.In the field of information technology, ISO and IEC have established a joint technical committee, ISO/IEC JTC 1.Draft International Standards adopted by the joint technical committee are circulated to national bodies

36、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 International Standard may be the subject ofpatent rights. ISO and IEC shall not be held responsible fo

37、r identifying any or all such patent rights.International Standard ISO/IEC 6592 was prepared by Joint Technical Committee ISO/IEC JTC 1, Informationtechnology,SubcommitteeSC7,Software engineering.This first edition cancels and replaces ISO 6592:1985, which has been technically revised.Annex A of thi

38、s International Standard is for information only.ISO/IEC 6592:2000(E) ISO/IEC 2000 All rights reservedvIntroductionDocumentation is essential to the success of any software development project. Management should determinethe quantity and content of documents to ensure there is neither too little nor

39、 too much. However, the mostimportant factor is to include all relevant information for the users. This International Standard provides a methodto define an adequate set of documents to use throughout the life cycle of a software development project,including its definition and use.INTERNATIONAL STA

40、NDARD ISO/IEC 6592:2000(E) ISO/IEC 2000 All rights reserved1Information technology Guidelines for the documentation ofcomputer-based application systems1 ScopeThis International Standard gives guidelines for the documentation of information systems (ISs) and is intended foruse in that area. This Int

41、ernational Standard is applicable to the software of IS. However, some aspects ofhardware, e.g. configuration of the system, are included.This International Standard is not intended to be a guide to the way documents are organized or structured.Instead, it provides a checklist for two parties to use

42、 in agreeing on document content.The guidelines given in this International Standard have been developed with the objectives of:Gb7 obtaining the necessary commitment of the parties involved with the life cycle of the IS to participate inthe development process;Gb7 contributing to the production of

43、well-planned, standardized software system documents;Gb7 enabling the production of software system documents in parallel with the software life cycle.Well-defined rules for documents during the software life cycle facilitates:Gb7 the provision of relevant information;Gb7 the preparation of the docu

44、mentation itself;Gb7 estimation of the time and resources required for the achievement of a project;Gb7 exchange of information between parties concerned, resulting in:- selection of attainable objectives for a system;- a more complete and well-considered functional design;- fewer misunderstandings

45、and mistakes;Gb7 making decisions and briefing of personnel during the software life cycle.This International Standard is designed to be applicable to the whole range of ISs and recognizes the softwarecomponent of a system may vary from a minor part to a major complex component.This International St

46、andard applies to documents in any natural language or representation and is independent ofthe medium used for its implementation, i.e., the principles are generally applicable, but in some cases there maybe differences in structure and format.Although this International Standard is intended mainly

47、for use in the software engineering (SE) area, there will beother groups involved less directly with SE including those involved in SE strategy, people with SE requirements,SE customers and SE users. This International Standard is relevant to those groups. The groups will producesome of the document

48、s (e.g., strategy, customer requirements and user documents).Associated with SE activities are methods, techniques and tools. Many of these products have their owndocumentation facilities. Software engineers may use documents of this type, but should ensure the principles andpractices given in this

49、International Standard are observed.ISO/IEC 6592:2000(E)2 ISO/IEC 2000 All rights reserved2 Normative referencesThis International Standard has no normative references. Informative references are listed in the bibliography.3 Terms and definitionsFor the purposes of this International Standard, the following definitions apply.3.1documentuniquely identified unit of information for human use, such as a report, specification, manual or book3.2documentationcollection of one or more related documents3.3information item (sub-item)defin