Streamlining your documentation using quick references

P. Reitman University of Colorado Denver

Abstract

Four types of quick references (small, portable packages of information) are described: slide rules, syntax summaries, informational guides, and posters and templates. Their design is discussed, covering the use of white space, type legibility, logical organization, inclusion of relevant information only, information accessibility, and effective headings.< <ETX xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:xlink="http://www.w3.org/1999/xlink">></ETX>

Journal
IEEE Transactions on Professional Communication
Published
1988-06-01
DOI
10.1109/47.6928
CompPile
Open Access
Closed
Topics
Export

Citation Context

Cited by in this index (2)

  1. IEEE Transactions on Professional Communication
  2. Journal of Technical Writing and Communication

References (11)

  1. Designing and Evaluating Standard Instructions for Public Telephones
    Bell System Technical Journal  
  2. User-Surly Software
    Computer Decisions
  3. A Cognitive Approach to Readability
    New Essays in Technical and Scientific Communication
  4. Pocket Pal A Graphic Arts Production Handbook
  5. Playing with Format, Style, and Reader Assumptions
    Technical Communication
Show all 11 →
  1. Creating Computer Software User Guides From Manuals to Menus
  2. 10.2190/NETC7
  3. Revising Functional Documents: The Scenario Principle
    New Essays in Technical and Scientific Communication
  4. The Complete Guide to Writing Software User Manuals
  5. Organizing the Technical Description
    Technical Communication
  6. Writing Better Computer User Documentation