NotesFAQContact Us
Search Tips
Back to results
ERIC Number: ED282524
Record Type: Non-Journal
Publication Date: 1987-Feb
Pages: 10
Abstractor: N/A
Reference Count: N/A
Designing Better Camels: Developing Effective Documentation for Computer Software.
Zacher, Candace M.
This guide to the development of effective documentation for users of computer software begins by identifying five types of documentation, i.e., training manuals, user guides, tutorials, on-screen help comments, and troubleshooting manuals. Six steps in the development process are then outlined and briefly described: (1) planning and preparation; (2) analysis and organization; (3) development and writing; (4) production; (5) distribution; and (6) maintenance. Organization of the documentation by tabs, sections, and subjects is recommended, and the advantages of setting standards are listed. The need for practical, flexible standards and commitment to them by all involved is emphasized. Checklists of design criteria, writer's rules, and design activities are also provided. Lists of advantages of effective documentation for the developer and for the user and learning principles to be considered in developing documentation are attached. (MES)
Publication Type: Guides - General; Speeches/Meeting Papers; Tests/Questionnaires
Education Level: N/A
Audience: Practitioners; Researchers
Language: English
Sponsor: N/A
Authoring Institution: N/A