Systems and software engineering - Content of life-cycle information items (documentation)
|Publication Date:||1 May 2017|
This document 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 document assumes an organization is performing life‐cycle processes, or practicing service management, using one or more of the following:
- ISO/IEC 12207:2008 (IEEE Std 12207‐2008), Systems and software engineering - Software life cycle processes;
- ISO/IEC/IEEE 15288:2015, Systems and software engineering - System life cycle processes;
- ISO/IEC 20000‐1:2011 (IEEE Std 20000‐1:2013), Information technology - Service management- Part 1: Service management system requirements; and
- ISO/IEC 20000‐2 (IEEE Std 20000‐2:2013), Information technology - Service management - Part 2: Guidance on the application of service management systems.
This document provides a mapping of processes from the above standards to 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.
This document does not establish a service management system.
ISO/IEC 12207:2008 (IEEE Std 12207‐2008) and ISO/IEC/IEEE 15288:2015 define a set of processes for managing and performing the stages of a software or system life cycle. They define an Information Management process, but do not "detail information items in terms of name, format, explicit content, and recording media".
ISO/IEC/IEEE 15288:2015 and ISO/IEC 12207:2008 (IEEE Std 12207‐2008) establish a common framework for system and software life‐cycle processes. They identify or require a number of documentation items. Their process reference model does not represent a particular process implementation approach, nor prescribe a system/software life‐cycle model, methodology or technique.
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), provides guidance on the use of ISO/IEC 20000‐1:2011 (IEEE Std 20000‐1:2013).
The generic document types defined in this document are used to identify the information necessary to support the following:
- the ISO/IEC/IEEE 15288:2015 agreement;
- organizational project‐enabling;
- technical management and processes;
- the ISO/IEC 12207:2008 (IEEE Std 12207‐2008) primary, supporting, and organizational life‐cycle processes; and
- the ISO/IEC 20000‐1:2011 (IEEE Std 20000‐1:2013) service management system (SMS), service delivery, relationship, resolution, and control processes.
The generic document types (which can be referred to as information item types) are used to identify the information necessary to support the ISO/IEC/IEEE 15288:2015 agreement, organizational project‐enabling, technical management, 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/IEEE 15288:2015 or ISO/IEC 12207:2008 (IEEE Std 12207‐2008). As ISO/IEC/IEEE 15288:2015 points out (1.4), "The users of this document are responsible for selecting a life cycle model for the project and mapping the processes, activities, and tasks in this document into that model. The parties are also responsible for selecting and applying appropriate methodologies, methods, models and techniques suitable for the project." Thus, information items are combined or subdivided consistent with the life cycle model, as needed for project or organizational purposes, as further defined in Clause 4, Applicability, and Clause 5, Conformance.
The scope of this document 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 systems or software life‐cycle data, records, information items, or documentation, such as electronic publishing systems, content management systems, or data repositories;
NOTE 1 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.
NOTE 2 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, contractual, organizational, and financial management that is not specific to systems and software engineering and information technology service management, such as business strategies, contract change notices, 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/IEEE 15288:2015 or ISO/IEC 12207:2008 (IEEE Std 12207‐2008) subclause not explicitly or implicitly identifying the recording of information about a process, 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 3 ISO/IEC 26514:2008, Systems and software engineering - Requirements for designers and developers of user documentation, provides guidance on formats for user documentation.