• There are no items in your cart

BS ISO/IEC 26514:2008

Superseded

Superseded

A superseded Standard is one, which is fully replaced by another Standard, which is a new edition of the same Standard.

View Superseded by

Software and systems engineering. Requirements for designers and developers of user documentation

Available format(s)

Hardcopy , PDF

Superseded date

03-03-2022

Language(s)

English

Published date

31-07-2008

Committee
IST/15
DevelopmentNote
Supersedes 07/30160567 DC. (08/2008) Supersedes BS 7137(1989), BS ISO/IEC 6592 and BS ISO/IEC 18019. (09/2008)
DocumentType
Standard
Pages
158
PublisherName
British Standards Institution
Status
Superseded
SupersededBy
Supersedes

This clause presents the scope, purpose, organization, and candidate uses of this International Standard.

This International Standard 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 this International Standard 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.

This International Standard neither encourages nor discourages the use of either printed or electronic (on-screen) media for documentation, or of particular documentation development or management tools or methodologies.

This International Standard may be helpful for developing the following types of documentation, although it does not cover all aspects of them:

  • documentation 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;

  • 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.

This International Standard is applicable to documentation designers and developers, including a variety of specialists:

  • information designers and architects who plan the structure and format of documentation products in a documentation set;

  • usability specialists and business analysts who identify the tasks that the intended users will perform with the software;

  • those who develop and edit the written content for user documentation;

  • graphic designers with expertise in electronic media;

  • user interface designers and ergonomics experts working together to design the presentation of the documentation on the screen.

This International Standard may also be consulted by those with other roles and interests in the documentation process:

  • managers of the software development process or the documentation process;

  • acquirers of documentation prepared by suppliers;

  • usability testers, documentation reviewers, subject-matter experts;

  • developers of tools for creating on-screen documentation;

  • human-factors experts who identify principles for making documentation more accessible and easily used.

This International Standard is intended for use in all types of organizations, whether or not a dedicated documentation department is present, and may be used as a basis for local standards and procedures. Readers are assumed to have experience or knowledge of software development or documentation development processes.

Users of this International Standard should adopt a style manual for use within their own organizations to complement the guidance provided in the annexes to this International Standard, or adopt an industry-recognized style guide. AnnexA provides guidance for the content of a style guide, and AnnexesB and C provide guidance on style.

The order of clauses in this International Standard does not imply that the documentation should be developed in this order or presented to the user in this order.

In each clause, the requirements are media-independent, as far as possible. Requirements specific to either print or electronic media are identified as such, particularly in Clause12. AnnexD provides guidance for the design of printed documentation.

The checklists in AnnexE may be used at each phase of the documentation process to check that the appropriate steps have been carried out and that the finished documentation satisfies quality criteria.

The checklists in AnnexesF and G may be used to track conformance with the requirements of this International Standard for documentation processes and products.

The bibliography lists works that provide guidance on the processes of managing, preparing, and testing user documentation.

Standards Relationship
ISO/IEC 26514:2008 Identical

ISO 9241-11:1998 Ergonomic requirements for office work with visual display terminals (VDTs) Part 11: Guidance on usability
ISO 9241-5:1998 Ergonomic requirements for office work with visual display terminals (VDTs) — Part 5: Workstation layout and postural requirements
ISO 9241-17:1998 Ergonomic requirements for office work with visual display terminals (VDTs) Part 17: Form filling dialogues
ISO 9241-10:1996 Ergonomic requirements for office work with visual display terminals (VDTs) Part 10: Dialogue principles
ISO 9241-9:2000 Ergonomic requirements for office work with visual display terminals (VDTs) Part 9: Requirements for non-keyboard input devices
ISO 9241-110:2006 Ergonomics of human-system interaction Part 110: Dialogue principles
ISO/IEC TR 9294:2005 Information technology Guidelines for the management of software documentation
ISO/IEC 9126-1:2001 Software engineering Product quality Part 1: Quality model
ISO 9241-12:1998 Ergonomic requirements for office work with visual display terminals (VDTs) Part 12: Presentation of information
ISO/IEC 11581-2:2000 Information technology User system interfaces and symbols Icon symbols and functions Part 2: Object icons
ISO/IEC TR 9126-4:2004 Software engineering Product quality Part 4: Quality in use metrics
ISO/IEC 15289:2006 Systems and software engineering Content of systems and software life cycle process information products (Documentation)
ISO 9241-16:1999 Ergonomic requirements for office work with visual display terminals (VDTs) Part 16: Direct manipulation dialogues
ISO 9241-7:1998 Ergonomic requirements for office work with visual display terminals (VDTs) Part 7: Requirements for display with reflections
ISO/IEC 14598-1:1999 Information technology Software product evaluation Part 1: General overview
ISO/IEC 11581-5:2004 Information technology — User system interfaces and symbols — Icon symbols and functions — Part 5: Tool icons
ISO/IEC 14598-6:2001 Software engineering Product evaluation Part 6: Documentation of evaluation modules
ISO/IEC 14598-4:1999 Software engineering Product evaluation Part 4: Process for acquirers
ISO/IEC 14598-2:2000 Software engineering Product evaluation Part 2: Planning and management
ISO 9241-14:1997 Ergonomic requirements for office work with visual display terminals (VDTs) — Part 14: Menu dialogues
ISO 216:2007 Writing paper and certain classes of printed matter Trimmed sizes A and B series, and indication of machine direction
ISO 9241-15:1997 Ergonomic requirements for office work with visual display terminals (VDTs) Part 15: Command dialogues
ISO/IEC 15288:2008 Systems and software engineering System life cycle processes
ISO/IEC 18019:2004 Software and system engineering Guidelines for the design and preparation of user documentation for application software
ISO/IEC 12207:2008 Systems and software engineering Software life cycle processes
ISO 999:1996 Information and documentation — Guidelines for the content, organization and presentation of indexes
ISO/IEC TR 9126-3:2003 Software engineering Product quality Part 3: Internal metrics
ISO 80416-2:2001 Basic principles for graphical symbols for use on equipment — Part 2: Form and use of arrows
IEEE 1063-2001 IEEE Standard for Software User Documentation
ISO 6357:1985 Documentation — Spine titles on books and other publications
ISO 9000:2015 Quality management systems — Fundamentals and vocabulary
ISO/IEC 14598-3:2000 Software engineering Product evaluation Part 3: Process for developers
ISO/IEC TR 9126-2:2003 Software engineering Product quality Part 2: External metrics
ISO 9241-2:1992 Ergonomic requirements for office work with visual display terminals (VDTs) — Part 2: Guidance on task requirements
ISO/IEC 11581-1:2000 Information technology User system interfaces and symbols Icon symbols and functions Part 1: Icons General
ISO 9241-6:1999 Ergonomic requirements for office work with visual display terminals (VDTs) Part 6: Guidance on the work environment
ISO/IEC 11581-6:1999 Information technology User system interfaces and symbols Icon symbols and functions Part 6: Action icons
ISO 9241-8:1997 Ergonomic requirements for office work with visual display terminals (VDTs) Part 8: Requirements for displayed colours
ISO 10007:2017 Quality management — Guidelines for configuration management
ISO/IEC 14598-5:1998 Information technology Software product evaluation Part 5: Process for evaluators
ISO 13407:1999 Human-centred design processes for interactive systems
ISO/IEC 11581-3:2000 Information technology User system interfaces and symbols Icon symbols and functions Part 3: Pointer icons
ISO 9241-13:1998 Ergonomic requirements for office work with visual display terminals (VDTs) — Part 13: User guidance

View more information
€382.44
Excluding VAT

Access your standards online with a subscription

Features

  • Simple online access to standards, technical information and regulations.

  • Critical updates of standards and customisable alerts and notifications.

  • Multi-user online standards collection: secure, flexible and cost effective.