• BS ISO/IEC 18019:2004

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

    Software and system engineering. Guidelines for the design and preparation of user documentation for application software

    Available format(s):  Hardcopy, PDF

    Superseded date:  31-07-2008

    Language(s):  English

    Published date:  21-01-2004

    Publisher:  British Standards Institution

    Add To Cart

    Table of Contents - (Show below) - (Hide below)

    Foreword
    Introduction
    1 Scope
    2 Terms and definitions
    3 Overview
      3.1 Forms of documentation
      3.2 Deciding what form of documentation to use
      3.3 Overview of the structure of this International
           Standard
    4 The objectives phase
      4.1 General
      4.2 Collect and interpret project requirements and
           constraints
      4.3 Documentation Proposal
    5 The planning phase
      5.1 General
      5.2 Documentation plan
      5.3 Review of detailed documentation plans
    6 The analysis and design phase
      6.1 Audiences
      6.2 Tasks
      6.3 Information
      6.4 Usability
      6.5 Structure of the documentation suite
      6.6 Individual document structures
      6.7 Document writing style
    7 The development and review phase
      7.1 General
      7.2 Prepare and issue drafts
      7.3 Check and review drafts
      7.4 Prepare subsequent drafts
      7.5 Prepare document masters
      7.6 Hand over the finished documentation
      7.7 Localisation and customisation
      7.8 Archiving
    8 The evaluation and updating phase
      8.1 General
      8.2 Evaluate the documentation
      8.3 Update the documentation
    9 Guidelines for the design of documentation
      9.1 Introduction
      9.2 Product copyright and version details
      9.3 Overview of the documentation
      9.4 Process descriptions
      9.5 Task descriptions
      9.6 Explanations of fields and options
      9.7 Names and uses of user interface options
      9.8 Descriptions of application functions
      9.9 Information messages
      9.10 Definitions of terms
      9.11 Concepts
      9.12 Exploitation information
      9.13 Frequently asked questions
      9.14 User-supplied content
      9.15 Navigation
      9.16 Presentation
      9.17 Icons and signposts
      9.18 Presentation of illustrations
    Annex A (informative) Process checklists
    Annex B (informative) Design checklist
    Annex C (informative) Evaluation of documentation
    Annex D (informative) Writing style and techniques
    Annex E (informative) Design and preparation of printed
            information
    Annex F (informative) Writing style guides - Contents
    Annex G (informative) ISO/IEC 18019 and related standards
    Bibliography

    Abstract - (Show below) - (Hide below)

    Gives guidelines for the design and preparation of user documentation for application software. 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 then to prepare the information and make it available.

    General Product Information - (Show below) - (Hide below)

    Committee IST/15
    Development Note Supersedes 02/647661 DC (02/2004)
    Document Type Standard
    Publisher British Standards Institution
    Status Superseded
    Superseded By
    Supersedes

    Standards Referenced By This Book - (Show below) - (Hide below)

    BS PAS 74(2008) : 2008 INTERNET SAFETY - ACCESS CONTROL SYSTEMS FOR THE PROTECTION OF CHILDREN ONLINE - SPECIFICATION
    BS PAS 124(2008) : 2008 DEFINING, IMPLEMENTING AND MANAGING WEBSITE STANDARDS: A STATEMENT OF BEST PRACTICE

    Standards Referencing This Book - (Show below) - (Hide below)

    ISO/IEC TR 9294:2005 Information technology Guidelines for the management of software documentation
    ISO 4196:1984 Graphical symbols — Use of arrows
    ISO/IEC 15910:1999 Information technology Software user documentation process
    ISO 216:2007 Writing paper and certain classes of printed matter Trimmed sizes A and B series, and indication of machine direction
    ISO/IEC 12207:2008 Systems and software engineering Software life cycle processes
    ISO 6357:1985 Documentation — Spine titles on books and other publications
    ISO/IEC TR 16326:1999 Software engineering Guide for the application of ISO/IEC 12207 to project management
    ISO/IEC TR 15846:1998 Information technology Software life cycle processes Configuration Management
    ISO/IEC 6592:2000 Information technology Guidelines for the documentation of computer-based application systems
    ISO 13407:1999 Human-centred design processes for interactive systems
    • 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, flexibile and cost effective