NASA Logo

NTRS

NTRS - NASA Technical Reports Server

Press Enter or click the Search button to begin your search.

Back to Results
Guidelines for preparing software user documentationClear, easy-to-use software user's manuals make strong demands on special technical communication techniques. Principles and guidelines are given for analyzing the audience and dealing with wide-ranging backgrounds of potential users. Types of information to be included in a complete manual are suggested, with a technique for creating a user-oriented rather than process-oriented organization. Accuracy verification is emphasized. Simple tips are gievn for formatting for quick comprehension and reference, for deciding on packaging, for creating helpful illustrations and examples, and for setting up clear and consistent conventions. Simple guidelines are offered for writing clearly and concisely and for editing.
Document ID
19880003577
Acquisition Source
Legacy CDMS
Document Type
Contractor Report (CR)
Authors
Miller, Diane F.
(Jet Propulsion Lab., California Inst. of Tech. Pasadena, CA, United States)
Date Acquired
September 5, 2013
Publication Date
October 1, 1987
Subject Category
Computer Programming And Software
Report/Patent Number
JPL-PUBL-87-22
NAS 1.26:181550
NASA-CR-181550
Report Number: JPL-PUBL-87-22
Report Number: NAS 1.26:181550
Report Number: NASA-CR-181550
Accession Number
88N12959
Funding Number(s)
CONTRACT_GRANT: NAS7-918
Distribution Limits
Public
Copyright
Work of the US Gov. Public Use Permitted.
No Preview Available