Anyone who uses application software needs accurate information about how the software will help the user accomplish a task. The documentation may be the first tangible item that the user sees and therefore influences the user’s first impressions of the software product. If the information is supplied in a convenient form and is easy to find and understand, the user can quickly become proficient at using the product. Hence, well-designed documentation not only assists the user and helps to reduce the cost of training and support, but also enhances the reputation of the product, its producer, and its suppliers.
Documentation is often regarded as something done after the software has been implemented. However, for high-quality software documentation, its development should be regarded as an integral part of the software life cycle process. If done properly, documentation or information management is a big enough job to require process planning in its own right.
BS ISO/IEC 26514 is the International Standard developed to assist users of BS ISO/IEC 15288:2002 Systems engineering. System life cycle processes, or BS ISO/IEC 12207:2008 Systems and software engineering. Software life cycle processes, to design and develop documentation as part of the software life cycle processes. It defines the documentation process from the documentation developer's standpoint.
BS ISO/IEC 26514 supports the interest of software users in consistent, complete, accurate, and usable documentation. It includes both approaches to standardization: a) process standards, which specify the way in which documentation products are to be developed; and b) documentation product standards, which specify the characteristics and functional requirements of the documentation.
The first part of this International Standard covers the user documentation process for designers and developers of documentation. It describes how to establish what information users need, how to determine the way in which that information should be presented to the users, and how to prepare the information and make it available. It is not limited to the design and development phase of the life cycle, but includes activities throughout the information management and documentation processes.
The second part of BS ISO/IEC 26514 provides minimum requirements for the structure, information content, and format of user documentation, including both printed and on-screen documents used in the work environment by users of systems containing software. It applies to printed user manuals, online help, tutorials, and user reference documentation.
BS ISO/IEC 26514 may be helpful for developing the following types of documentation:
- Documentation of products other than software
- Multimedia systems using animation, video, and soun
- Computer-based training (CBT) packages and specialized course materials intended primarily for use in formal training programs
- Documentation produced for installers, computer operators, or system administrators who are not end users
- Maintenance documentation describing the internal operation of systems software
- Documentation incorporated into the user interface itself.
Contents of BS ISO/IEC 26514 include:
- Conformance
- Application of conformance
- Conformance situations
- Normative references
- Terms and definitions
- User documentation process within the systems/software life cycle
- Project requirements, objectives, and constraints
- Analysis and design
- Development and review
- Production
- Structure of documentation
- Information content of user documentation
- Presentation format of documentation
- Bibliography
