Systems and software engineering - Content of life-cycle information items (documentation)
|Publication Date:||15 May 2015|
|ICS Code (Software):||35.080|
This International Standard specifies the purpose and content of all identified systems and software life-cycle and service management information items (documentation). The information item contents are defined according to generic document types, as presented in Clause 7, and the specific purpose of the document (Clause 10).
This International Standard assumes an organization is implementing life-cycle processes, or practicing service management, using one or more of the following:
- ISO/IEC 15288:2008 (IEEE Std 15288-2008), Systems and software engineering - System life cycle processes,
- ISO/IEC 12207:2008 (IEEE Std 12207-2008), Systems and software engineering - Software life cycle processes
- ISO/IEC 20000-1:2011 (IEEE Std 20000-1-2013), Information technology - Service management - Part 1: Service management system requirements
This International Standard provides a mapping of ISO/IEC 15288:2008 (IEEE Std 15288-2008), ISO/IEC 12207:2008 (IEEE Std 12207-2008), and ISO/IEC 20000-1:2011 (IEEE Std 20000-1-2013) and ISO/IEC 20000-2 (IEEE Std 20000-2-2013) clauses with a set of information items. It provides a consistent approach to meeting the information and documentation requirements of systems and software engineering and IT service management.
ISO/IEC 12207:2008 (IEEE Std 12207-2008) and ISO/IEC 15288:2008 (IEEE Std 15288-2008) define a set of processes for managing and performing the stages of a systems life cycle. They define an Information Management process, but they do "not detail documentation in terms of name, format, explicit content, and recording media". ISO/IEC 15288:2008 (IEEE Std 15288-2008), and ISO/IEC 12207:2008 (IEEE Std 12207-2008) establish a common framework for software life-cycle processes and in passing identify or require a number of documentation items. Its process reference model does not represent a particular process implementation approach, nor does it prescribe a system/software life-cycle model, methodology, or technique. ISO/IEC 12207:2008 (IEEE Std 12207-2008) does not always specify when software information items are to be prepared, nor does it identify information item contents. ISO/IEC 20000-1:2011 (IEEE Std 20000-1-2013) establishes comprehensive requirements for documents and records, with some specific requirements. ISO/IEC 20000-2:2012 (IEEE Std 20000-2-2013), Information technology - Service management - Part 2: Guidance on the application of service management systems provides guidance on the use of Part 1.
The generic document types (which may be referred to as information item types) are to be used to identify the information necessary to support the ISO/IEC 15288:2008 (IEEE Std 15288-2008) agreement, enterprise, project, and technical processes; the ISO/IEC 12207:2008 (IEEE Std 12207-2008) primary, supporting, and organizational life-cycle processes; or the ISO/IEC 20000-1:2011 (IEEE Std 20000-1-2013) service management system (SMS), service delivery, relationship, resolution, and control processes.
For each life-cycle process or service, it would be possible to prepare a policy, plan, procedures, and reports, as well as numerous records, requests, descriptions and specifications. Such an elaboration of the documentation schema would be more rigorous than specified by ISO/IEC 15288:2008 (IEEE Std 15288-2008) or ISO/IEC 12207:2008 (IEEE Std 12207-2008). As ISO/IEC 15288:2008 (IEEE Std 15288-2008) points out (1.4), "This International Standard does not detail the life-cycle processes in terms of methods or procedures required to meet the requirements and outcomes of a process." Thus, information items may be combined or subdivided as needed for project or organizational purposes, as further defined in Clause 2, Applicability, and Clause 3, Conformance.
This International Standard does not establish a service management system.
The scope of this International Standard does not include the following:
a) the format or content of recommended input data or input information items, except for the content of those input items that are also output information items;
b) instructions on combining or subdividing information items and information item contents of a similar nature;
c) guidance on selecting an appropriate presentation format, delivery media, and maintenance technology for system and software life-cycle data, records, information items, or documentation, such as electronic publishing systems, content management systems, or data repositories;
NOTE 1 ISO/IEC/IEEE 26531, System and software engineering - Content management for product life-cycle, user, and service management documentation, provides requirements for content management and component content management systems.
d) detailed content for information items related to general business, organizational, and financial management that is not specific to systems and software engineering and information technology service management, such as business strategies, human resources and investment policies, personnel selection criteria, financial budgeting and accounting policies and procedures, cost reports, or payroll data;
e) information items showing only approval of an ISO/IEC 12207:2008 (IEEE Std 12207-2008) subclause, such as ISO/IEC 12207:2008 (IEEE Std 12207-2008), 184.108.40.206.4.5;
f) any ISO/IEC 15288:2008 (IEEE Std 15288-2008) or ISO/IEC 12207:2008 (IEEE Std 12207-2008) subclause not explicitly or implicitly identifying the recording of information about an activity or task, for example, ISO/IEC 12207:2008 (IEEE Std 12207-2008), 6.4.4;
g) work products, models, software, and other artifacts of life-cycle products and services that are not information items or records used in information items.
NOTE 2 ISO/IEC 26514:2008, Systems and software engineering - Requirements for designers and developers of user documentation, provides guidance on formats for software user documentation.
NOTE 3 ISO/IEC 15504-5:2012, Information technology - Process Assessment - Part 5: An exemplar software life cycle process assessment model, Annex B (informative), and ISO/IEC 15504-6:2013 Information technology - Process assessment - Part 6: An exemplar system life cycle process assessment model, Annex B (informative) detail the content of work products as well as information items. Their guidance includes descriptions of a set of information items (documents) that an assessor may encounter. The information items in their guidance may be produced by combinations and subdivisions of the required information items in this International Standard.
The purpose of this International Standard is to provide requirements for users of ISO/IEC 12207:2008 (IEEE Std 12207-2008), ISO/IEC 15288:2008 (IEEE Std 15288-2008) and ISO/IEC 20000-1:2011 (IEEE Std 20000-1-2013) for identifying and planning the specific information items (information products) to be developed and revised during systems and software life cycles and service management processes. This International Standard is intended for use as follows.
a) To address the technical information needed by those involved in ISO/IEC 15288:2008 (IEEE Std 15288- 2008) and ISO/IEC 12207:2008 (IEEE Std 12207-2008) processes.
b) To specify information in an agreement process as described in ISO/IEC 15288:2008 (IEEE Std 15288- 2008) or a two-party situation as described in ISO/IEC 12207:2008 (IEEE Std 12207-2008), ISO/IEC 20000-1:2011 (IEEE Std 20000-1-2013) and ISO/IEC 20000-2:2012 (IEEE Std 20000-2-2013). The twoparty situation may range from an informal agreement within an organization to a legally binding contract between organizations.
c) To develop information items that provide evidence for process assessment performed with respect to ISO/IEC 15504, and to guide process improvement activities.
d) To guide a single party in self-imposed tasks.
Intended users of this International Standard
This International Standard is applicable for use by:
a) project managers responsible for the Information Management process of ISO/IEC 15288:2008 (IEEE Std 15288-2008) (6.3.6) during a system life cycle;
b) project managers responsible for identifying information item requirements and document contents when using ISO/IEC 12207:2008 (IEEE Std 12207-2008), or any other software engineering life-cycle process, to help determine what should be documented, when the documentation should be developed, and what the contents of the documents should be;
c) acquirers responsible for determining what information items are needed to help ensure the quality of the project, or delivered system, product or service;
d) individuals who write or support the design and development of service, systems and software information items;
e) individuals responsible for identifying information items required to claim conformance with ISO/IEC 12207:2008 (IEEE Std 12207-2008), ISO/IEC 15288:2008 (IEEE Std 15288-2008), or ISO/IEC 20000-1:2011 (IEEE Std 20000-1-2013);
f) individuals undertaking service, system or software process improvement in their organizations.
Applicability to work efforts
Use of this International Standard is not limited by size, complexity or criticality of the project. It may be applied to:
a) any type of project and life-cycle process;
b) any of the activities and tasks of a project and system or software product or service life cycle;
c) all forms of information items, information item content and document delivery media;
d) documentation in Commercial-Off-The-S
NOTE See ISO/IEC 12207:2008 (IEEE Std 12207-2008), 1.2.
Applicability to information item audiences
Users of this International Standard should map this International Standard to the requirements and needs of their agreements, or project and organizational procedures. The type of decision to be made or the work to be performed, by users of the information should be considered before an information item is prepared. Reviewing and understanding the requirements, needs, and background of users and stakeholders are essential to applying this International Standard accurately and economically, since some information items are designed for various purposes and user groups:
a) To provide information to specialized types of users who may not be a part of a particular project;
b) To address the same type of user but in environments not normally coexisting in the same effort;
c) To aid both users who are expected to be computer-literate and understand technical terminology, and users who may not have this background.