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

2Scope / Description

This document addresses the development of software user documentation from the perspectives of information designers and developers. It describes how to identify the information users need, determine how that information should be presented to them, and then produce and make it accessible. The guidelines extend beyond the design and development phases, covering documentation throughout the entire lifecycle—from the design strategy to the maintenance of the documentation. The document specifies requirements for the structure, content, and format of software user documentation.

It applies to the development of the following types of documentation, though not necessarily all aspects thereof:
— Documentation for non-software products;
— Multimedia systems incorporating animation, video, and audio;
— Computer-based training (CBT) packages and specialized learning materials, particularly those designed for use within formal training programs;
— Maintenance documentation describing the internal operation of system software;
— User information embedded directly within the user interface.

The document is intended for information architects and documentation developers, including various specialists:
— Information architects responsible for designing the structure and format of information products;
— Usability specialists and business analysts who identify tasks that intended users will perform with the software;
— Writers and editors responsible for the written content of user documentation;
— Designers with expertise in electronic media;
— User interface designers and ergonomics experts who jointly devise methods for presenting information on screen.

Additionally, the document serves as a reference for other stakeholders involved in the user documentation development process, such as:
— Project managers responsible for the software development or documentation development process;
— Acquirers of user documentation produced by suppliers;
— Usability testers, reviewers of user documentation, and subject matter experts;
— Developers of tools used to create user documentation;
— Human factors specialists tasked with defining principles that make user documentation easier to access and use.