IEEE 1063 Software User Documentation

	Purchase Information Use this form to request purchase information on IEEE online subscriptions. IEEE Collections First Name: Last Name: Email address:

Document IEEE 1063 is offered by IHS as part of an online subscription. This subscription contains many documents on the same topic.

You may also purchase this document alone from the IHS Standards Store.

IEEE 1063 Document Information:

Title
Software User Documentation

The Institute of Electrical and Electronics Engineers, Inc.

Publication Date:
Dec 5, 2001

Scope:

This standard provides minimum requirements for the structure, information content, and format of user documentation, including both printed and electronic documents used in the work environment by users of systems containing software. This standard is limited to the software documentation product and does not include the processes of developing or managing software user documentation; it applies to printed user manuals, online help, and user reference documentation. It does not apply to specialized course materials intended primarily for use in formal training programs.

This standard is intended neither to encourage nor discourage the use of either printed or electronic (online) media for documentation, or of any particular documentation development or management tools or methodologies. Users of this standard may want to develop a style manual for use within their own organizations to complement the guidance provided in the standard, or to adopt an industry-recognized style guide. Users of this standard may also want to perform usability testing on the software user documentation. The works listed in the bibliography provide guidance on the processes of managing, preparing, and testing user documentation (see Annex A).

Purpose

This revision provides requirements for the structure, information content, and format of both printed and electronic documentation. It addresses the interests of software acquirers, producers, and users in standards for consistent, complete, accurate, and usable documentation.

Keywords:

online help

software user documentation

user manual

About IHS
IHS (NYSE: IHS) is a leading global provider of critical technical information, decision-support tools and related services in a number of industries including aerospace and defense, automotive, construction, electronics, and energy. IHS serves customers ranging from large governments and multinational corporations to smaller companies and technical professionals in more than 100 countries. IHS been in business for more than 45 years and employ more than 2,300 people around the world.