Physical Address
304 North Cardinal St.
Dorchester Center, MA 02124
ISO/IEC IEEE 26514: Software Engineering — Requirements for Designers and Developers of User Documentation
Best practices for designing and developing high-quality software user documentation
ISO/IEC IEEE 26514 specifies the requirements for the design and development of user documentation for software products. It provides a structured methodology for transforming raw product information into well-organized, user-centered documentation that enables users to install, learn, use, and maintain software products effectively. This standard is the core reference for the technical communicators who create user documentation, defining the processes, techniques, and quality criteria that should govern documentation development activities.
The 26514 standard is to technical communicators what ISO 9001 is to quality managers — it defines the fundamental process framework that, when properly implemented, consistently produces documentation that meets user needs and organizational objectives.
Information Design and Architecture
The design phase of documentation development begins with information architecture — the structural organization of content to support user tasks and information retrieval. The standard requires designers to analyze user tasks, identify the information needed to perform each task, and organize that information into a coherent structure. This structure is typically represented as a topic hierarchy or information map, showing the relationships between different content elements and defining the navigation pathways that users will follow.
The standard advocates for a modular approach to content design, where documentation is composed of discrete, self-contained topics rather than continuous narrative prose. Each topic should address a single purpose — a concept, a task, a reference, or troubleshooting guidance — and should be understandable without requiring the user to read preceding topics. This modular approach, sometimes called “topic-based authoring,” supports multiple output formats from a single source (printed PDF, online help, embedded assistance), enables content reuse across multiple products, and facilitates translation and localization by reducing the interdependencies between content elements.
| Information Type | Purpose | Example Content |
|---|---|---|
| Conceptual | Explains background knowledge and principles | System architecture overview, data flow explanation |
| Procedural | Provides step-by-step task instructions | Installation steps, configuration procedure |
| Reference | Describes detailed specifications | API reference, configuration parameter table |
| Troubleshooting | Helps resolve common problems | Error message guide, diagnostic procedures |
| Getting Started | Enables initial product use | Quick start guide, first-run tutorial |
A prevalent anti-pattern in documentation design is organizing content according to the software’s internal architecture rather than the user’s task flow. For example, a system administration guide organized by configuration file rather than by administration task forces users to understand the implementation before they can perform their jobs. The standard requires task-oriented organization.
Content Development Standards and Writing
The standard establishes comprehensive requirements for the content development process itself. Each documentation project should have a documented style guide that defines: terminology standards, grammar and punctuation conventions, graphical standards for illustrations and screenshots, typographic conventions for indicating user interface elements, accessibility requirements for content, and localization and translation considerations. The style guide ensures consistency across documents, especially when multiple writers contribute to a documentation set.
Writing requirements in 26514 address both the macro level (document structure, headings, information grouping) and the micro level (sentence construction, terminology, cross-references). The standard emphasizes writing for the target audience’s reading level and technical background, using active voice and imperative mood for procedural content, providing concrete examples for abstract concepts, and ensuring that each sentence adds value for the reader. The standard also addresses visual communication — the use of diagrams, screenshots, tables, and other visual elements to convey information more effectively than text alone.
The modular, topic-based approach advocated by 26514 has been shown to reduce documentation development costs by 20-30% through content reuse, accelerate translation cycles by 30-40% through reduced content interdependencies, and improve user task completion rates by 15-25% compared to traditional narrative-style documentation.
Output Production and Delivery Formats
The standard recognizes that user documentation must be delivered in formats appropriate to the user’s context of use. Requirements include: producing documentation in at least one durable format (such as PDF for printing) and one navigable format (such as HTML for online viewing), supporting accessibility features required by relevant regulations, providing search functionality for electronic formats, ensuring that formatting and layout do not obscure content meaning, and maintaining consistent branding and visual identity across all documentation deliverables.
For online documentation specifically, the standard requires attention to hyperlink clarity (links should describe their destination), navigation consistency (similar content should be reachable through similar navigation paths), responsive design (documentation must be usable on different screen sizes and devices), and search optimization (content should be structured to support effective search engine indexing and retrieval). The standard also addresses the growing importance of embedded assistance — contextual help that appears within the software interface at the moment of need — as a complement to traditional standalone documentation.
A critical requirement that is often overlooked is the need to test documentation in its delivered format before release. Documentation that looks correct in the authoring environment may have formatting issues, broken links, or rendering problems in the production output. The standard requires formal output validation as part of the documentation development process.
Frequently Asked Questions
Q: Does 26514 prescribe specific authoring tools or methodologies?
A: No. The standard is tool-agnostic and methodology-neutral. It defines what must be achieved (the requirements) rather than how to achieve it (the implementation). Organizations can use any authoring tools, content management systems, or development methodologies that satisfy the requirements.
A: No. The standard is tool-agnostic and methodology-neutral. It defines what must be achieved (the requirements) rather than how to achieve it (the implementation). Organizations can use any authoring tools, content management systems, or development methodologies that satisfy the requirements.
Q: How does 26514 address documentation for international audiences?
A: The standard includes requirements for localization readiness, including separating content from formatting, avoiding culturally specific metaphors and examples, using controlled language to simplify translation, and providing sufficient context in the source content for translators.
A: The standard includes requirements for localization readiness, including separating content from formatting, avoiding culturally specific metaphors and examples, using controlled language to simplify translation, and providing sufficient context in the source content for translators.
Q: Can 26514 be applied to non-software products that have user documentation?
A: While the standard is written in the context of software engineering, many of its requirements are applicable to any product that requires user documentation, including hardware products, medical devices, industrial equipment, and consumer electronics.
A: While the standard is written in the context of software engineering, many of its requirements are applicable to any product that requires user documentation, including hardware products, medical devices, industrial equipment, and consumer electronics.
Q: How does the standard address single-sourcing and content reuse?
A: The standard supports single-sourcing through its modular topic-based architecture requirement and provides guidance on managing reusable content components, including version control of reusable topics and impact analysis when shared content is modified.
A: The standard supports single-sourcing through its modular topic-based architecture requirement and provides guidance on managing reusable content components, including version control of reusable topics and impact analysis when shared content is modified.
