Customer Service:
Mon - Fri: 8:30 am - 6 pm EST

Documentation

Documentation for software engineering standards are published by ISO/IEC/IEEE. They include the ISO/IEC/IEEE 26510 series, which cover managers of information for user of systems, software, and services, acquirers and suppliers of information for users, testers and reviewers of information for users, design and development of information for users, developing information for user in an agile environment, content of life-cycle information items, and documentation of evaluation modules.


ISO/IEC/IEEE 26511:2018

Systems and software engineering - Requirements for managers of information for users of systems, software, and services

This document supports the needs of users for consistent, complete, accurate, and usable information. It provides requirements for strategy, planning, managing, staffing, translation, production, and quality and process-maturity assessment for managers of information for users. It specifies processes and procedures for managing information for users throughout the product- or systems-development life cycle. It also includes requirements for key documents produced for managing information for users, including strategic and project plans. This document provides an overview of the information-management processes that are specific for the management of information for users. It addresses the following activities: developing a comprehensive strategy for information development; assessing user information needs; planning and managing an information-development project; staffing and forming information-development teams; reviewing and testing information for users; managing the translation process; publishing and delivering information for users; evaluating customer satisfaction and information quality; measuring productivity, efficiency, and costs; and evaluating organizational maturity. The guidance in this document applies to multiple project management approaches, including both agile and traditional practices. Traditional practices can encompass predictive, waterfall, or other top-down management methods. Where certain practices are common in agile project management, they are noted. This document is applicable for use by managers of information for users or organizations with information developers. This document can also be consulted by those with other roles and interests in the process of developing information for users: managers of the product and system development process; acquirers of information for users prepared by suppliers; experienced information developers who prepare information for users; human-factors experts who identify principles for making information for users more accessible and easily used; and user interface designers and ergonomics experts working together to design the presentation of information. This document can be applied to manage the following types of information for users, although it does not cover all aspects of them: information for user assistance, training, marketing, and systems documentation for product design and development, based on reuse of user information topics; multimedia marketing presentations using animation, video, and sound; information developed for virtual and augmented reality presentations; computer-based training (CBT) packages and course materials intended primarily for use in formal training programs; and information describing the internal operation of products.


ISO/IEC/IEEE 26512:2018

Systems and software engineering - Requirements for acquirers and suppliers of information for users

This document supports the interest of system users in having consistent, complete, accurate, and usable information. It addresses both available approaches to standardization: a) process standards, which specify the way that information products are to be acquired and supplied; and b) information product standards, which specify the characteristics and functional requirements of the information. As defined in ISO/IEC/IEEE 12207 and ISO/IEC/IEEE 15288:2015, the acquisition and supply activities make up the agreement processes of the software or system life cycle. Acquisition and supply of information for users and related services are specializations of those processes. Such services can be acquired and supplied for any part of the information management process, such as the following: - information management; - information design and development; - information editing and review coordination; - information testing, particularly usability testing; - information production and packaging; - information distribution and delivery; - advice on the selection and implementation of information development tools and supporting systems; and - information development process improvement. This document provides an overview of the information management processes that are relevant to the acquisition and supply of information for users. It applies the Agreement processes (acquisition and supply) to information for users, and addresses the preparation of requirements for this information. These requirements are central to the information for users specification and statement of work discussed in this document. This document also addresses requirements for primary document outputs of the acquisition and supply process: the request for proposal and the proposal for documentation products and services. This document is intended for use in acquiring or supplying any type of information for users and is independent of information development or management tools or methodologies. This document might be helpful for acquiring and supplying the following types of information, although it does not cover all aspects of them: - multimedia systems 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; - collaboratively generated, often known as wiki , documentation, which will usually need to be curated periodically; and - information for users incorporated into the user interface. This document is applicable to acquirers and suppliers of information for users, including a variety of specialists: - analysts (e.g., business analysts, human factors engineers) who identify the tasks that the intended users will perform with the system; - managers of the software or system development process or the information management process; - managers of the acquisition process, and those who authorize and approve acquisitions; and - managers and authors involved in proposal preparation. It can also be consulted by those with other roles and interests in the information development process: - information designers and architects who plan the structure, format, and content requirements of information products; - experienced authors and editors who develop the written content for information for users; - graphic designers with expertise in electronic media; - user interface designers and ergonomics experts working together to design the presentation of the information on the screen; - usability testers, information development reviewers, technical contacts; - developers of tools for creating on-screen information for users.



ISO/IEC/IEEE 26514:2022

Systems and software engineering - Design and development of information for users

This document covers the development process for designers and developers of information for users of software. It describes how to establish what information users need, how to determine the way in which that information should be presented, and how to prepare the information and make it available. It is not limited to the design and development stage of the life cycle, but includes information on design throughout the life cycle, such as design strategy and maintaining a design. This document provides requirements for the structure, information content, and format of information for users of software. This document can be applied to developing the following types of information, although it does not cover all aspects of them: — information for users of products other than software; — multimedia systems using animation, video, and sound; — computer-based training (CBT) packages and specialized course materials intended primarily for use in formal training programs; — maintenance information describing the internal operation of systems software; — information for users incorporated into the user interface itself. This document is applicable to information architects and information developers, including a variety of specialists: — information architects who plan the structure and format of information products; — usability specialists and business analysts who identify the tasks that the intended users can perform with the software; — developers and editors of the written content of information for users; — graphic designers with expertise in electronic media; — user interface designers and ergonomics experts working together to design the presentation of the information on the screen. This document is also a reference for those with other roles and interests in the process of developing information for users: — managers of the software development process or the information-development process; — acquirers of information for users prepared by suppliers; — usability testers, reviewers of information for users, subject-matter experts; — developers of tools for creating information for users; — human-factors experts who identify principles for making information for users more accessible and easily used.


ISO/IEC/IEEE 26515:2018

Systems and software engineering - Developing information for users in an agile environment

This document supports the interest of information developers and associated roles responsible for producing information for users of software and systems developed within an agile environment. This document takes a process standard approach to specify the way in which information for users can be developed in agile development projects. This document provides requirements of information management and information development processes appropriate for software projects that are using agile development methods. Clause 5 covers the overall requirements for information in agile software development. Clause 6 covers requirements for the information development lead or project manager to plan an agile information development project and manage the information development activities in an agile environment. Clause 7 covers requirements for designing, developing, and providing information for users in an agile environment. Annex A describes agile development practices and methods. This document is intended neither to encourage nor to discourage the use of any particular agile development tools or methods. This document provides guidance on processes appropriate for information developers of information for users in software and systems projects that are using agile development methodologies. It is not limited to the development phase of the life cycle of information for users, but includes activities throughout the whole life cycle. This document is intended for use in all organizations that are using agile development or are considering implementing their projects using these techniques. It is assumed that users of this document have experience or general knowledge of information for users (traditionally called user documentation ) and agile processes.


ISO/IEC/IEEE 15289:2019

Systems and software engineering - Content of life-cycle information items (documentation)

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, as presented in Clause 10. This document assumes an organization is performing life cycle processes, or delivering system or software engineering services, using either or both of the following: ISO/IEC/IEEE 12207:2017 software life cycle processes; ISO/IEC/IEEE 15288:2015 system life cycle processes. ISO/IEC/IEEE 12207:2017 and ISO/IEC/IEEE 15288:2015 define an Information Management process, but do not detail information items in terms of name, format, explicit content, and recording media (ISO/IEC/IEEE 12207:2017, 1.4). These standards identify, recommend or require a number of documentation items. 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 engineering service management. The generic document types defined in this document are used to identify the information necessary to support the processes required by ISO/IEC/IEEE 12207:2017 and ISO/IEC/IEEE 15288:2015. The generic document types (which can be referred to as information item types) are used to identify the information necessary to support the 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 12207:2017 or ISO/IEC/IEEE 15288:2015. As ISO/IEC/IEEE 15288:2015, 1.4 points out, 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 and Clause 5. This document is not a management system standard and does not establish a service management system, quality management system, or asset management system. 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 ISO/IEC/IEEE 26531 provides requirements for content management and component content management systems. ISO/IEC 26514 provides guidance on formats for user documentation (information for users). 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 engineering service management, such as business strategies, contract change notices (agreement change report), 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/IEEE 12207:2017 or ISO/IEC/IEEE 15288:2015 subclause, such as ISO/IEC/IEEE 12207:2017, 6.4.10.3 c) 3); f) any ISO/IEC/IEEE 15288:2015 or ISO/IEC/IEEE 12207:2017 subclause not explicitly or implicitly identifying the recording of information about a process, activity or task, for example, ISO/IEC/IEEE 12207:2017, 6.2.4.3 c); 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.


ISO/IEC 14598-6:2001

Software engineering -- Product evaluation -- Part 6: Documentation of evaluation modules

This part of ISO/IEC 14598 defines the structure and content of the documentation to be used to describe an Evaluation Module. Evaluation modules are intended to be used within the context of the ISO/IEC 9126 and the ISO/IEC 14598 multipart standards. This part of ISO/IEC 14598 is intended to be used by experts in evaluation technology such as testing laboratories, research institutes and others when producing new evaluation modules.


ANSI Logo

As the voice of the U.S. standards and conformity assessment system, the American National Standards Institute (ANSI) empowers its members and constituents to strengthen the U.S. marketplace position in the global economy while helping to assure the safety and health of consumers and the protection of the environment.

CUSTOMER SERVICE
NEW YORK OFFICE
ANSI HEADQUARTERS