A Structured Approach to Technical Project Documentation

Abstract

The documentation describing a technical project or product frequently takes one of two forms: too little documentation to present the necessary information properly, or too much documentation poorly organized and poorly written. To help overcome this problem, a four-level approach to project documentation is described, with documents assigned to each level according to their intended use. The technical writer can then judge how to construct a given document because the audience for each documentation level is clearly defined.

Journal
Journal of Technical Writing and Communication
Published
1983-10-01
DOI
10.2190/aak6-8yl7-7byt-cn9c
CompPile
Search in CompPile ↗
Open Access
Closed
Export

Citation Context

Cited by in this index (2)

  1. Journal of Technical Writing and Communication
  2. Journal of Technical Writing and Communication

References (9) · 3 in this index

  1. Handbook of Technical Writing Practices
  2. Handbook of Technical Writing Practices
  3. Journal of Technical Writing and Communication
  4. Journal of Technical Writing and Communication
  5. Hall R. C., Lunar Impact: A History of Project Ranger, NASA Special Publication SP-4210, U.S. Government Prin…
Show all 9 →
  1. Handbook of Technical Writing Practices
  2. Medical Communications
  3. Technical Communication
  4. Journal of Technical Writing and Communication