as nzs 4598.1-1999 guide to the development of application software software user documentation
TRANSCRIPT
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
1/12
AS/NZS 4598.1:1999BS 7649:1993
Australian/New Zealand Standard
Guide to the development of applicationsoftware
Part 1: Software user documentation
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
2/12
AS/NZS 4598.1: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 CommunicationAustralian 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 Wales
University 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 StandardsAustralia and Standards New Zealand Catalogue of Publications; this information issupplemented each month by the magazines The Australian Standard and Standards
New 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 be madewithout delay in order that the matter may be investigated and appropriate action taken.
This Standard was issued in draft form for comment as DR 99190.
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
3/12
AS/NZS 4598.1:1999
Australian/New Zealand Standard
Guide to the development of applicationsoftware
Part 1: Software user documentation
First published as AS/NZS 4598.1: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 2885 5
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
4/12
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 7649:1993, Guide to the design and preparation of documentation forusers 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 application software covering what
information users need, how to decide what information should be provided (on paper and on-
screen) and how to prepare the relevant documentation.
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 the
cover and title page.(b) In the source text this British Standard should read this Australian/New Zealand
Standard.
(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 or
Australian/New Zealand Standards:
Reference to International Standard Australian or Australian/New Zealand
Standard
BS AS
3700 Recommendations for preparing
indexes to books, periodicals andother documents
4000
4000-1
4000-2
Sizes of paper and board
Part 1: Specification for A and B
series of trimmed sizes of writing
paper and certain classes of
printed matters
Part 2: Specification for
untrimmed sizes
4884
4884-1
4884-2
4884-3
Technical manuals
Part 1: Specification for
presentation of essential
information
Part 2: Guide to content
Part 3: Guide to presentation
4899
4899-1
4899-2
Guide to users requirements for
technical manuals (based on the
principles of BS 4884)
Part 1: Content
Part 2: Presentation
5097
5097-1
Specification for loose leaf
bindersPart 1: Ring binders with metal
mechanisms
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
5/12
iii
BS AS
5261C Marks for copy preparation and
proof correction (extracted from
BS 5261 : Part 2 : 1976)
5515 Code of practice fordocumentation of computer-based
systems
5605 Recommendations for cit ing and
referencing published material
5641 Recommendations for loose-leaf
publications
5750 Quality systems
5848 Specif ication for numbering of
divisions and subdivisions in
written documents (point-numbering)
6738 Recommendations for
presentation of spine titles
7137 Specification for user
documentation and cover
information for consumer
software packages
7165 Recommendations for
achievement of quality in software
7581 Guide to presentation of tablesand graphs
ISO/IEC TR 9294 Information technology.
Guidelines for the management of
software documentation
3897 Information processing
Guidelines for the management
of software documentation
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.
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
6/12
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
7/12
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
8/12
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
9/12
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
10/12
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
11/12
-
7/31/2019 As NZS 4598.1-1999 Guide to the Development of Application Software Software User Documentation
12/12
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.1:1999, Guide to the development ofapplication software Software user 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=385300&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