Customer Support: 131 242

  • There are no items in your cart
We noticed you’re not on the correct regional site. Switch to our AMERICAS site for the best experience.
Dismiss alert

BS ISO/IEC/IEEE 26513:2017

Current
Current

The latest, up-to-date edition.

Systems and software engineering. Requirements for testers and reviewers of information for users
Available format(s)

Hardcopy , PDF

Language(s)

English

Published date

31-12-2017

1 Scope
2 Normative references
3 Terms and definitions
4 Conformance
5 Review and assessment processes of user
  documentation within the software lifecycle
6 Documentation evaluation strategy
7 Documentation evaluation methods and procedures
Annex A (informative) - User-centered test and review
        guidelines
Bibliography

Provides the interest of software users in receiving consistent, complete, accurate, and usable documentation and specifies processes for use in testing and reviewing of user documentation.

This document supports the interest of software users in receiving consistent, complete, accurate, and usable documentation and specifies processes for use in testing and reviewing of user documentation (Clause6). It is not limited to the test and review stage of the lifecycle, but includes activities throughout the information management and documentation management process.

This document is intended for use in all types of organizations, whether or not a dedicated documentation department is present. In all cases, it can be used as a basis for local standards and procedures. Readers are assumed to have experience or general knowledge of testing or reviewing processes.

This document deals with the evaluation of end-user content only, and not with the evaluation of the software it supports.

NOTE1 Documentation is also included in evaluation of the software product, as in the ISO/IEC25000 and 29000 series of standards. In particular:

  • ISO/IECTR25060;

  • ISO/IEC25062;

  • ISO/IEC25063:2014;

  • ISO/IEC25064:2013; and

  • ISO/IEC/IEEE29119‑3:2013.

This document provides the minimum requirements for testing and reviewing user documentation (Clause7), including both printed and online documents used in work and other environments by the users of software which includes application software, systems software, apps on mobile devices, and software that controls machinery or hardware devices. It applies to printed user manuals, online help, user assistance, tutorials, websites, and user reference documentation.

This document can also be helpful for testing and reviewing the following types of documentation:

  • documentation of products other than software, for example, hardware or devices;

  • multimedia systems using animation, video, and sound;

  • tutorial 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; and

  • maintenance documentation describing the internal operation of systems software.

This document is applicable to testers, reviewers, and other related roles, including a variety of specialists:

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

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

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

  • editors;

  • test participants;

  • installers, computer operators, or system administrators; and

  • customer support groups such as training, help desks, repair, and return.

The document can also be consulted by those with other roles and interests in the information management process. Managers of the software development process or the information management process consider the testing of documentation as part of their planning and management activities. Project managers, in particular, have an important role in supporting the review and testing of documentation.

Testing of the documentation is likely to highlight any defects or nonconformances in tools that are used to create or display online documentation. Similarly, usability testing of the documentation is likely to identify additional operational concerns or misunderstandings of end users.

NOTE2 Testing of documentation can highlight problems with the software being documented. Resolving problems with the software is not in the scope of this document.

There are other roles that need to understand the test processes for the documentation; for example, information developers should understand the test processes for the documentation that they have produced, and acquirers of documentation prepared by another department or organization might want to know what testing has been performed and the processes followed for the documentation that they are acquiring from a supplier.

The order of clauses in this document does not imply that software user documentation is meant to be reviewed, assessed, edited, or tested in this order.

In each clause, the requirements are media-independent, as far as possible. The informative guidelines found in AnnexA, User-Centered Test and Review Guidelines, can be used at each stage of the information management process to verify that the correct steps have been carried out and that the finished product has acceptable quality.

The works listed in the Bibliography provide additional guidance on the processes of managing, preparing, and testing of user documentation.

Committee
IST/15
DevelopmentNote
Supersedes 16/30317608 DC. (12/2017)
DocumentType
Standard
Pages
52
PublisherName
British Standards Institution
Status
Current

Standards Relationship
ISO/IEC/IEEE 26513:2017 Identical

ISO 128-40:2001 Technical drawings General principles of presentation Part 40: Basic conventions for cuts and sections
ISO 9241-171:2008 Ergonomics of human-system interaction — Part 171: Guidance on software accessibility
ISO/IEC/IEEE 15288:2015 Systems and software engineering — System life cycle processes
ISO 128-34:2001 Technical drawings General principles of presentation Part 34: Views on mechanical engineering drawings
ISO 9241-210:2010 Ergonomics of human-system interaction Part 210: Human-centred design for interactive systems
ISO 9241-12:1998 Ergonomic requirements for office work with visual display terminals (VDTs) Part 12: Presentation of information
ISO 9241-151:2008 Ergonomics of human-system interaction Part 151: Guidance on World Wide Web user interfaces
ISO/IEC 25051:2014 Software engineering Systems and software Quality Requirements and Evaluation (SQuaRE) Requirements for quality of Ready to Use Software Product (RUSP) and instructions for testing
ISO/IEC 25040:2011 Systems and software engineering Systems and software Quality Requirements and Evaluation (SQuaRE) Evaluation process
ISO/IEC 25000:2014 Systems and software engineering Systems and software Quality Requirements and Evaluation (SQuaRE) Guide to SQuaRE
ISO/IEC/IEEE 24765:2017 Systems and software engineering — Vocabulary
ISO/IEC/IEEE 26515:2011 Systems and software engineering Developing user documentation in an agile environment
ISO/IEC 14598-6:2001 Software engineering Product evaluation Part 6: Documentation of evaluation modules
ISO/IEC/IEEE 15289:2017 Systems and software engineering Content of life-cycle information items (documentation)
ISO 128-44:2001 Technical drawings General principles of presentation Part 44: Sections on mechanical engineering drawings
ISO/IEC 26514:2008 Systems and software engineering Requirements for designers and developers of user documentation
ISO 128-30:2001 Technical drawings General principles of presentation Part 30: Basic conventions for views
ISO/IEC 25001:2014 Systems and software engineering Systems and software Quality Requirements and Evaluation (SQuaRE) Planning and management
ISO/IEC 25062:2006 Software engineering Software product Quality Requirements and Evaluation (SQuaRE) Common Industry Format (CIF) for usability test reports
ISO 9001:2015 Quality management systems — Requirements
ISO 9000:2015 Quality management systems — Fundamentals and vocabulary
IEC 82079-1:2012 Preparation of instructions for use - Structuring, content and presentation - Part 1: General principles and detailed requirements

View more information
$568.62
Including GST where applicable

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.

Need help?
Call us on 131 242, then click here to start a Screen Sharing session
so we can help right away! Learn more