Abstract

Complicated documents often affect readers the way computer programs affect computers; technical writers are prone to many of the same serious errors that plague programmers. Among the many principles that writers can learn from programming are: 1) Models save money: it is far more economical to develop detailed outlines and mockups than to improvise from a vague outline. 2) Quality demands maintainability: every complicated document will need frequent revision, and only documents designed for ease of change will be kept current. 3) The trouble is in the interfaces: the procedures and tasks in a manual are not as error-prone as the rules for moving from part to part of the book itself. 4) Readers are subject to the laws of physics: many publication economies produce documents that defy the physical powers of the reader. 5) Communication is control: readers must be prevented from getting lost.

Journal
Journal of Technical Writing and Communication
Published
1986-07-01
DOI
10.2190/lerk-yjv9-qyuc-vnt0
CompPile
Search in CompPile ↗
Open Access
Closed
Topics
Export

Citation Context

Cited by in this index (2)

  1. Written Communication
  2. IEEE Transactions on Professional Communication

References (6)

  1. Technical Communication
  2. How to Write a Usable User Manual
  3. The Next Wave in User Documentation, Computerworld, September 9, 1985.
  4. Why We “Still” Have So Little Technical Documentation, Infosystems, May, 1983.
  5. Don't Count On the Course: Why Writing Training Fails, Training News, August, 1984.
Show all 6 →
  1. The Writing System for Engineers and Scientists