As NZS 4598.2-1999 Guide to the Development of Application Software on-Screen Documentation

7/31/2019 As NZS 4598.2-1999 Guide to the Development of Application Software on-Screen Documentation

1/13

AS/NZS 4598.2:1999BS 7830:1996

Australian/New Zealand Standard

Guide to the development of applicationsoftware

Part 2: On-screen documentation


2/13

AS/NZS 4598.2:1999

This Joint Australian/New Zealand Standard was prepared by Joint Technical CommitteeIT/15, Software Engineering. It was approved on behalf of the Council of StandardsAustralia on 14 July 1999 and on behalf of the Council of Standards New Zealand on28 June 1999. It was published on 5 August 1999.

The following interests are represented on Committee IT/15:

Australian Association of Chief Information OfficersAustralian Bankers AssociationAustralian Computer SocietyAustralian Electrical and Electronic Manufacturers AssociationAustralian Information Industry AssociationAustralian Society for Technical Communication

Australian Software Metrics AssociationComputer Aided Software Engineering Special Interest GroupDefence Science and Technology OrganizationDepartment of Defence, AustraliaGriffith UniversityIEEE Computer SocietyIndigenous Information Industries GroupNew Zealand Organization for QualityQuality Society of AustralasiaSoftware Process Improvement Network, Sydney, AustraliaSoftware Quality AssociationSoftware Verification Research CentreTelstra CorporationUniversity of New South WalesUniversity of South Australia

Review of Standards. To keep abreast of progress in industry, Joint Australian/New Zealand Standards are subject to periodic review and are kept up to date by the issueof amendments or new editions as necessary. It is important therefore that Standards usersensure that they are in possession of the latest edition, and any amendments thereto.

Full details of all Joint Standards and related publications will be found in the Standards

Australia and Standards New Zealand Catalogue of Publications; this information issupplemented each month by the magazines The Australian Standard and StandardsNew Zealand, which subscribing members receive, and which give details of newpublications, new editions and amendments, and of withdrawn Standards.

Suggestions for improvements to Joint Standards, addressed to the head office of eitherStandards Australia or Standards New Zealand, are welcomed. Notification of anyinaccuracy or ambiguity found in a Joint Australian/New Zealand Standard should bemade without delay in order that the matter may be investigated and appropriate actiontaken.

This Standard was issued in draft form for comment as DR 99191.


3/13

AS/NZS 4598.2:1999

Australian/New Zealand Standard

Guide to the development of applicationsoftware

Part 2: On-screen documentation

First published as AS/NZS 4598.2:1999

Published jointly by:

Standards Australia

1 The Crescent,

Homebush NSW 2140 AustraliaStandards New Zealand

Level 10, Radio New Zealand House,

155 The Terrace,

Wellington 6001 New Zealand

ISBN 0 7337 2884 7


4/13

ii

PREFACE

This Standard was prepared by the Joint Standards Australia/Standards New Zealand

Committee IT/15, Software Engineering. This Standard is identical with and has been

reproduced from BS 7830:1996, Guide to the design and preparation of on-screendocumentation for users of application software.

The objective of this Standard is to provide designers of application software with guidelines

for the design and preparation of user documentation for on-screen covering content,

navigation, style and presentation.

The term informative has been used in this Standard to define the application of the annex to

which it applies. An informative annex is only for information and guidance.

As this Standard is reproduced from a British Standard, the following applies:

(a) Its number does not appear on each page of text and its identity is shown only on thecover and title page.

(b) In the source text this British Standard should read this Australian/New ZealandStandard.

(c) A full point should be substituted for a comma when referring to a decimal marker.

References to British Standards should be replaced by references to the following

Australian/New Zealand Standards:

Reference to International Standard Australian/New Zealand Standard

BS AS/NZS

7649 Guide to the design and

preparation of documentation for

users of application software

4598

4598.1

Guide to the development of

application software

Part 1: Software user

documentation

BS EN

29241

29241-1

29241-2

29241-3

Ergonomic requirements for office

work with visual display terminals

(VDTs)

Part 1: General introduction

Part 2: Guidance on task

requirements

Part 3: Visual display

requirements

ISO 9001 Quality systems. Model forquality assurance in design,

development, production,

installation and servicing

ISO 9001 Quality systemsModel forquality assurance in design,

development, production,

installation and servicing

BS

ISO/IEC 12119 Information technology

Software packagesQuality

requirements and testing

4366 Information technology

Software packagesQuality

requirements and testing

ISO/IEC


Software product evaluation

Quality characteristics and

guidelines for their use


Software product evaluation

Quality characteristics and

guidelines for their use


5/13

iii

ISO/IEC AS/NZS

12207 Information Technology

Software life cycle process

ISO/IEC 12207 Information technology

Software life cycle process

Copyright STANDARDS AUSTRALIA/STANDARDS NEW ZEALAND

Users of Standards are reminded that copyright subsists in all Standards Australia and Standards New Zealand publications andsoftware. Except where the Copyright Act allows and except where provided for below no publications or software produced byStandards Australia or Standards New Zealand may be reproduced, stored in a retrieval system in any form or transmitted by anymeans without prior permission in writing from Standards Australia or Standards New Zealand. Permission may be conditional onan appropriate royalty payment. Australian requests for permission and information on commercial software royalties should bedirected to the head office of Standards Australia. New Zealand requests should be directed to Standards New Zealand.

Up to 10 percent of the technical content pages of a Standard may be copied for use exclusively in-house by purchasers ofthe Standard without payment of a royalty or advice to Standards Australia or Standards New Zealand.

Inclusion of copyright material in computer software programs is also permitted without royalty payment provided suchprograms are used exclusively in-house by the creators of the programs.

Care should be taken to ensure that material used is from the current edition of the Standard and that it is updated whenever theStandard is amended or revised. The number and date of the Standard should therefore be clearly identified.

The use of material in print form or in computer software programs to be used commercially, with or without payment, or incommercial contracts is subject to the payment of a royalty. This policy may be varied by Standards Australia or StandardsNew Zealand at any time.


6/13


7/13


8/13


9/13


10/13


11/13


12/13


13/13

This is a free preview. Purchase the entire publication at the link below:

Looking for additional Standards? Visit SAI Global Infostore

Subscribe to ourFree Newsletters about Australian Standards in Legislation; ISO, IEC, BSI and more

Do you need to Manage Standards Collections Online?

Learn about LexConnect, All Jurisdictions, Standards referenced in Australian legislation

Do you want to know when a Standard has changed?

Want to become an SAI Global Standards Sales Affiliate?

Learn about other SAI Global Services:

LOGICOM Military Parts and Supplier DatabaseMetals Infobase Database of Metal Grades, Standards and Manufacturers

Materials Infobase Database of Materials, Standards and Suppliers

Database of European Law, CELEX and Court Decisions

Need to speak with a Customer Service Representative - Contact Us

AS/NZS 4598.2:1999, Guide to the development ofapplication software On-screen documentation
http://infostore.saiglobal.com/store?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Newsletters/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Collections/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Law/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/StandardsWatch/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Affiliate/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Databases/LOGICOM/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Databases/LOGICOM/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Databases/Metals/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Databases/Materials/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Databases/European-Law/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://infostore.saiglobal.com/store/getpage.aspx?path=/InformationServices/shop/pages/ContactingUs.htm&utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://infostore.saiglobal.com/store/Details.aspx?ProductId=385308&utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://infostore.saiglobal.com/store/getpage.aspx?path=/InformationServices/shop/pages/ContactingUs.htm&utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Databases/European-Law/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Databases/Materials/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Databases/Metals/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Databases/LOGICOM/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Affiliate/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/StandardsWatch/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Law/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Collections/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://www.saiglobal.com/Information/Standards/Newsletters/?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSiteshttp://infostore.saiglobal.com/store?utm_source=PDF&utm_medium=Website_Infostore&utm_campaign=DocSharingSites

Documents

As NZS 4598.2-1999 Guide to the Development of Application Software on-Screen Documentation