AS/NZS 4598.2:1999

Guide to the development of application software On-screen documentation

Standards Australia

More info

Introduction
Section 1 - General
1.1 Scope
1.2 Informative references
1.3 Definitions
Section 2 - Overview
2.1 General
2.2 The process
2.3 Guidelines for the documentation
Process
Section 3 - Objectives
3.1 General
3.2 Input
3.3 Subjects
3.4 Activities
3.5 Documentation Proposal
Section 4 - Planning and control
4.1 General
4.2 Aspects of planning and control
4.3 Development activities
Section 5 - Analysis
5.1 General
5.2 Users
5.3 Tasks
5.4 Information needed by users
5.5 Usability
5.6 Technical options
5.7 Documentation Requirements
Section 6 - Design
6.1 General
6.2 Deciding what medium to use
6.3 Choosing development and delivery tools
6.4 Designing the content
6.5 Designing the structure
6.6 Designing the navigation
6.7 Designing the writing and illustration styles
6.8 Designing the presentation
6.9 Specifying the usability goals
6.10 Developing prototypes
6.11 User trials
6.12 Documentation Specification
Section 7 - Implementation
7.1 General
7.2 Collecting details of the application
7.3 Drafting the information
7.4 Building the information systems
7.5 Checking the information
7.6 Handling over the finished documentation
7.7 Localization and customization
7.8 Archiving
Guidelines
8.1 General
8.2 Product copyright and version details
8.3 Overview of the application
8.4 Overview of the documentation
8.5 How to use the onscreen documentation
8.6 Process descriptions
8.7 Task descriptions
8.8 Explanations of fields and options
8.9 Names and uses of user interface items
8.10 Descriptions of application functions
8.11 Messages
8.12 Definitions of terms
8.13 Concepts
8.14 Exploitation information
8.15 Frequently asked questions
8.16 User-supplied contents
Section 9 - Navigation
9.1 General
9.2 Accessing onscreen information
9.3 Finding the right information
9.4 Knowing what the current information is
9.5 Knowing the current position within a topic
9.6 Finding the same information again
9.7 Switching between the application and the
documentation
9.8 Printing information
9.9 Moving to a different topic
9.10 Obtaining clarification or amplification of some
current information
9.11 Browsing through information
9.12 Viewing topics in order
9.13 Exiting from the onscreen documentation
9.14 Finding user-supplied information
9.15 Sizes of topics and fragments
Section 10 - Style
10.1 General
10.2 Conventions
10.3 Vocabulary
10.4 Terminology
10.5 Writing styles
10.6 Writing techniques
10.7 Lists
10.8 Tables
10.9 Illustrations
Section 11 - Presentation
11.1 General
11.2 Windowing
11.3 Layout and grids
11.4 Colour
11.5 Controls
11.6 Typography
11.7 Icons and signposts
11.8 Pointers
11.9 Illustrations
Annexes
A (informative) - Process checklists
A.1 Objectives
A.2 Planning
A.3 Analysis
A.4 Design
A.5 Implementation
B (informative) - Review checklists
B.1 Content checklist
B.2 Navigation checklist
B.3 Style checklist
B.4 Presentation checklist
C (informative) - Evaluation
C.1 General
C.2 Procedure
C.3 Views
C.4 Qualities
C.5 Evaluation methods
D (informative) - How to use this British Standard
E (informative) - Bibliography
E.1 Reference books
E.2 Use of English
E.3 Preparing on-screen user documentation
E.4 Interface design
E.5 Ergonomics
Index

Abstract

Provides designers of application software with guidelines for the design and preparation of user documentation for on-screen covering content, navigation, style and presentation. This Standard is identical with and has been reproduced from BS 7830:1996.