We noticed you’re not on the correct regional site. Switch to our AMERICAS site for the best experience.
  • BS 7649:1993

    Withdrawn A Withdrawn Standard is one, which is removed from sale, and its unique number can no longer be used. The Standard can be withdrawn and not replaced, or it can be withdrawn and replaced by a Standard with a different number.
    Add to Watchlist
    This Standard has been added successfully to your Watchlist
    Please visit My Watchlist to see all standards that you are watching.
    Please log in or to add this standard to your Watchlist.
    We could not add this standard to your Watchlist.
    Please retry or contact support for assistance.
    We could not add this standard to your Watchlist.
    Please retry or contact support for assistance.
    You have already added this standard to your Watchlist.
    Visit My Watchlist to view the full list.

    GUIDE TO THE DESIGN AND PREPARATION OF DOCUMENTATION FOR USERS OF APPLICATION SOFTWARE

    Available format(s):  Hardcopy, PDF

    Withdrawn date:  03-08-2017

    Language(s):  English

    Published date:  01-01-1993

    Publisher:  British Standards Institution

    Add to Watchlist

    Add To Cart

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

    GENERAL
    Foreword
    Introduction
    Section 1. General
    1.1 Scope
    1.2 Informative references
    1.3 Definitions
    PROCESS
    Section 2. Integrated design and development of software
    products
    2.1 Integrated development stages
    2.2 Responsibilities for documentation activities
    2.3 Local standards and procedures
    2.4 Documentation processes
    2.5 Sequence of documentation activities
    Section 3. Project objectives, requirements and
    constraints
    3.1 General
    3.2 Collect and interpret project requirements and
          constraints
    Section 4. Analysis
    4.1 General
    4.2 Collect details of users
    4.3 Determine what documentation users need
    4.4 Record users' needs for information
    4.5 Produce the outline documentation plan
    Section 5. Planning
    5.1 General
    5.2 Design the content, structure and style of each
          document
    5.3 Set the editorial standards
    5.4 Design the physical presentation of each document
    5.5 Design the complete package
    5.6 Decide how the documents will be developed
    5.7 Decide how the documents will be produced
    5.8 Decide how the documents will be updated
    5.9 Estimate costs
    5.10 Prepare schedules
    5.11 Revise the design
    5.12 Write the documentation plan
    5.13 Review the documentation plan
    Section 6. Development and review
    6.1 General
    6.2 Prepare and issue first draft
    6.3 Check and review drafts
    6.4 Prepare subsequent drafts
    6.5 Validation and field trials
    6.6 Prepare master pages
    Section 7. Production and distribution
    7.1 General
    7.2 Submit master pages for production
    7.3 Package the documents and software
    7.4 Check the finished documents and package
    7.5 Archive the master versions
    7.6 Distribute the product
    Section 8. Evaluation and updating
    8.1 General
    8.2 Evaluate the documentation
    8.3 Update the documentation
    DETAILED DESIGN
    Section 9. Document contents
    9.1 General
    9.2 Contents of awareness or appreciation documents
    9.3 Contents of installation instructions
    9.4 Contents of tutorials
    9.5 Contents of quick reference documents
    9.6 Contents of comprehensive reference documents
    Section 10. Document structures
    10.1 General
    10.2 Structure of awareness or appreciation documents
    10.3 Structure of installation instructions
    10.4 Structure of tutorial documents
    10.5 Structure of quick reference documents
    10.6 Structure of comprehensive reference documents
    10.7 Numbering schemes for pages, sections,
          illustrations and tables
    Section 11. Document writing styles
    11.1 General
    11.2 Writing style for awareness and appreciation
          documents
    11.3 Writing style for installation instructions
    11.4 Writing style for tutorial documents
    11.5 Writing style for quick reference documents
    11.6 Writing style for comprehensive reference
          documents
    11.7 Types of illustration
    Section 12. Document writing techniques
    12.1 General
    12.2 Writing techniques
    12.3 Vocabulary
    12.4 Technical terms
    Section 13. Document presentation
    13.1 General
    13.2 Page layouts
    13.3 Use of colour
    13.4 Presentation of text
    13.5 Presentation of lists, tables and notes
    13.6 Presentation of illustrations
    13.7 Special symbols and icons
    13.8 Quality and durability of the finished documents
    13.9 Binding
    13.10 Packaging
    13.11 Cover information
    Section 14. Document contents lists and indexes
    14.1 General
    14.2 Contents lists
    14.3 Indexes
    Tables
    1. Kinds of information for different learning stages
    2. Types of documents and their uses
    3. Methods of preparing master pages
    4. Methods of producing multiple copies
    5. The suitability of types of binding for different
         needs
    6. Example list of types of user
    7. Example task list
    8. Example task hierarchy
    9. Example chart of users and tasks
    10. Example of information needed by one user type
    11. Example of grouping information into documents
    12. Example entry for an outline documentation plan
    13. The planning process
    14. The development and review process
    15. The production and distribution process
    16. The evaluation and updating process
    17. Example structure of an awareness document
    18. Example structure of a getting started tutorial
    19. Example structure of a tutorial for normal use
    20. Example structures of quick reference documents
    21. Example structure of a task-related comprehensive
         reference document
    22. Example structure of a software-related
         comprehensive reference document
    23. Example of a table used to illustrate a complicated
         condition
    24. Page grid for this British Standard
    25. Page grid for an A5 page
    26. Example A5 page
    27. Example of the use of bold and italic and different
         typefaces and sizes
    ANNEXES
    A. (informative) Bibliography
    A.1 Reference books
    A.2 Use of English
    A.3 Preparing user documentation
    A.4 Typography
    B. (informative) Collected checklists
    B.1 Project objectives, requirements and constraints
    B.2 Analysis
    B.3 Planning
    B.4 Development and review
    B.5 Production and distribution
    Index
    List of references

    Abstract - (Show below) - (Hide below)

    Gives advice on the design and preparation of user documentation for application software. Includes sections on: integrated design and development of software products; project objectives, requirements and constraints; document contents lists and indexes. Also includes tables, annexes and diagrams.

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

    Committee IST/15
    Development Note Supersedes 90/66493 DC (10/2005) Reviewed and confirmed by BSI, November 2012. (10/2012)
    Document Type Standard
    Publisher British Standards Institution
    Status Withdrawn

    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 4884-3(1993) : 1993 TECHNICAL MANUALS - GUIDE TO PRESENTATION
    BS 7830:1996 GUIDE TO THE DESIGN AND PREPARATION OF ON-SCREEN DOCUMENTATION FOR USERS OF APPLICATION SOFTWARE
    BS ISO/IEC 15910 : 1999 INFORMATION TECHNOLOGY - SOFTWARE USER DOCUMENTATION PROCESS
    BS TICKIT GUIDE : ISSUE 5.5 A GUIDE TO SOFTWARE QUALITY MANAGEMENT SYSTEM CONSTRUCTION AND CERTIFICATION TO ISO 9001:2000
    IEEE 1063 : 2001 STANDARD FOR SOFTWARE USER DOCUMENTATION

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

    BS ISO/IEC TR 9294 : 1990 INFORMATION TECHNOLOGY - GUIDELINES FOR THE MANAGEMENT OF SOFTWARE DOCUMENTATION
    BS 5641:1982 RECOMMENDATIONS FOR LOOSE LEAF PUBLICATIONS
    BS 7137(1989) : 1989 SPECIFICATION FOR USER DOCUMENTATION AND COVER INFORMATION FOR CONSUMER SOFTWARE PACKAGES
    BS 5097-1:1974 SPECIFICATION FOR LOOSE LEAF BINDERS - RING BINDERS WITH METAL MECHANISMS
    BS 4899-1:1991 GUIDE TO USER'S REQUIREMENTS FOR TECHNICAL MANUALS (BASED ON THE PRINCIPLES OF BS 4884) - CONTENT
    BS 5848:1980 SPECIFICATION FOR NUMBERING OF DIVISIONS AND SUBDIVISIONS IN WRITTEN DOCUMENTS (POINT NUMBERING)
    BS 7165(1991) : 1991 RECOMMENDATIONS FOR ACHIEVEMENT OF QUALITY IN SOFTWARE
    BS 4899-2:1992 GUIDE TO USER'S REQUIREMENTS FOR TECHNICAL MANUALS (BASED ON THE PRINCIPLES OF BS 4884) - PRESENTATION
    BS 7581(1992) : 1992 GUIDE TO PRESENTATION OF TABLES AND GRAPHS
    • 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