Re: "Industry standard" for software user documentation?

Subject: Re: "Industry standard" for software user documentation?
From: "Damien Braniff" <Damien -dot- Braniff -at- asg -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 27 Sep 2005 08:39:14 +0100


Documentation standards galore :-)

BS ISO/IEC 18019:2004 'Software and system engineering. Guidelines for
the design and preparation of user documentation for application
software'
See http://www.techscribe.co.uk/techw/iso_18019.htm for a brief
description.

Also Technical Management: Documentation Standard by Ken Rigby may be
worth checking out.
(check Amazon
http://www.amazon.co.uk/exec/obidos/ASIN/1904504000/managingstand-21/202
-1882049-1957465)

Other standards that may be of interest:
ISO 6357:1985 Recommendations for the presentation of spine titles.
ISO/IEC 6592:2000, Information Technology, Guidelines for the
documentation of computer-based application systems.
ISO/IEC 9127:1988 User documentation and cover information for consumer
software packages
ISO/IEC TR 9294: 2005 - Guidelines for the management of software
documentation
ISO/IEC 15910:1999, Information technology - Software user documentation
process (based upon Australian/New Zealand standard AS/NZS 4258).
ISO/IEC 11581 - Information Technology - Icon symbols and functions
(multipart standard, parts 1, 2, 3 and 6 have been published).
ISO/IEC 13251 - Information Technology - Collection of graphical symbols
for office equipment (in final development stage).
BS ISO/IEC 14143-1:1998 Information technology. Software measurement.
Functional size measurement. Definition of concepts.
ISO TS 16071:2003 - Guidance on accessibility for human-computer
interfaces.
ISO/IEC 18035:2003 - Information technology - Icon symbols and functions
for controlling multimedia software applications.
ISO/IEC 18036:2003 - Information technology - Icon symbols and functions
for World Wide Web browser toolbars.
BS 308-1.16:1997 (BS EN ISO 2203:1997) and BS 308-2.3:1995 (BS EN ISO
1660:1996) Technical Drawings.
BS 308-1.17:1996 (BS EN ISO 2162.1:1996), BS 308-1.18:1996 (BS EN ISO
2162.2:1996) and BS 308-1.19:1996 (BS EN ISO 2162.3:1996) Technical
product documentation.
BS 3700:1988 Recommendations for preparing the indexes to books,
periodicals and other documents.
BS 4884 Technical manuals (three parts, 1992 - 1993).
BS 4899 Guide to user's requirements for technical manuals (based on the
principles of BS 4884) (two parts, 1991 & 1992).
BS 5097:1974 Specification for loose leaf binders. Ring binders with
metal mechanisms.
BS 5261 Copy preparation and proof correction (three parts, 1976 -
2001).
BS 5605:1990 Recommendations for citing and referencing published
material.
BS 5775 (ISO 31) Specification for quantities, units and symbols
(multipart standard).
BS 7581:1992 Guide to presentation of tables and graphs.
IEEE 1063:2001 - Standard for software user documentation
BS EN 80416 - Basic principles for graphical symbols for use on
equipment (4 part standard, parts 1, 2 and 3 have been published.)

Damien Braniff | Technical Writer
damienb -at- asg -dot- com
Technical Communications
ASG | asg.com
Waterfront Plaza
8, Lagan Bank Road,
Belfast, N. Ireland BT1 3LR
Tel: +44 (0) 28.9072.3124
Fax: +44 (0) 28.9072.3324
End-to-End Technology Management


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: Re:Content of Help Systems
Next by Author: RE: "Industry standard" for software user documentation?
Previous by Thread: Re: "Industry standard" for software user documentation?
Next by Thread: RE: "Industry standard" for software user documentation?


What this post helpful? Share it with friends and colleagues:


Sponsored Ads