Abstract
The sections in this article are
- 1 Exploring what Makes Documents Successful
- 2 Using a Process Model as a Job Aid for Successful Documents
- 3 Planning Successful Documents
- 4 Working out the Logistics of a Document Project
- 5 Focusing on the Content that users Need
- 6 Organizing to help users
- 7 Writing so users can Understand what they Find
- 8 Formatting (The Other Meaning of “Document Design”)
- 9 Reviewing, Evaluating, and Revising Drafts
Bibliography
- 1 J. C. Redish The language of the bureaucracy, in R. W. Bailey and R. M. Fosheim (eds.), Literacy for Life: The Demand for Reading and Writing, New York: Modern Language Association, 1983, pp. 151–174.
- 2
R. M. Battison
D. G. Goswami
Clear writing today,
J. Bus. Commun.,
18 (4):
5–16,
1981.
10.1177/002194368101800401 Google Scholar
- 3 J. R. Hayes A new framework for understanding cognition and affect in writing, in C. M. Levy and S. Ransdell (eds.), The Science of Writing: Theories, Methods, Individual Differences, and Applications, Mahwah, NJ: Lawrence Erlbaum, 1996, pp. 1–27.
- 4 J. C. Redish Understanding readers, in C. Barnum and S. Carliner (eds.), Techniques for Technical Communicators, New York: Macmillan, 1993, pp. 14–41.
- 5 J. T. Hackos J. C. Redish User and Task Analysis for Interface Design, New York: Wiley, 1998.
- 6 D. Wixon J. Ramey (eds.) Field Methods Casebook for Software Design, New York: Wiley, 1996.
- 7 T. Sticht Understanding readers and their uses of texts, in T. M. Duffy and R. Waller (eds.), Designing Usable Texts, Orlando, FL: Academic, 1985, pp. 315–340.
- 8 J. C. Redish Reading to learn to do, Tech. Writing Teacher, 15 (3): 223–233, 1988. Reprinted in IEEE Trans. Prof. Commun., 32: 289–293, 1989.
- 9 P. Wright Writing technical information, in E. Z. Rothkopf (ed.), Review of Research in Education, 14, Washington, DC: American Educational Research Association, 1987, pp. 327–385.
- 10 T. F. Callaghan posting to a private listserve, August 28, 1997, used with author’s permission.
- 11 J. T. Hackos Managing Your Documentation Projects, New York: Wiley, 1994.
- 12 D. A. Norman The Design of Everyday Things, New York: Doubleday, 1988.
- 13 P. Sullivan L. Flower How do users read computer manuals? Some protocol contributions to writers’ knowledge, in B. T. Petersen (ed.), Convergences: Transactions in Reading and Writing, Urbana IL: National Council of Teachers of English, 1986, pp. 163–178.
- 14 P. Wright Issues of content and presentation in document design, in M. Helander (ed.), Handbook of Human-Computer Interaction, Amsterdam: North-Holland, 1988, pp. 629–652.
- 15 D. D. Pieratti How the process and organization can help or hinder adding value, Tech. Commun., 42 (1): 61–68, 1995.
- 16 M. Cover D. Cooke M. Hunt Estimating the cost of high-quality documentation, Tech. Commun., 42 (1): 76–83, 1995.
- 17 J. C. Redish Minimalism in technical communication: Some issues to consider, in J. M. Carroll (ed.), Minimalism Since the Nurnberg Funnel, Cambridge, MA: MIT Press, in cooperation with the Society for Technical Communication, 1998, pp. 219–245.
- 18 L. Flower J. R. Hayes H. Swarts Revising functional documents: The scenario principle, in P. V. Anderson, R. J. Brockmann, and C. R. Miller (eds.), New Essays in Technical and Scientific Communication: Research, Theory, Practice, Farmingdale, NY: Baywood, 1983, pp. 41–58.
- 19 K. A. Schriver Dynamics in Document Design, New York: Wiley, 1997.
- 20 R. Horn Structured writing and text design, in D. H. Jonassen (ed.), The Technology of Text: Principles for Structuring, Designing, and Displaying Text, Englewood Cliffs, NJ: Educational Technology Publications, 1982, pp. 341–368.
- 21 E. H. Weiss How to Write a Usable User Manual, Philadelphia: ISI Press, 1985.
- 22 B. Mirel S. Feinberg L. Allmendinger Designing manuals for active learning styles, Tech. Commun., 38 (1): 75–88, 1991.
- 23 J. C. Redish Document design, in K. Houp, T. Pearsall, and E. Tebeaux, Reporting Technical Information, 9th ed., Boston: Allyn and Bacon, 1998, Chap. 8.
- 24 J. V. White Graphic Design for the Electronic Age, New York: Watson-Guptill, 1988.
- 25 J. Miles Design for Desktop Publishing, San Francisco: Chronicle Books, 1987.
- 26 E. Keyes Typography, color, and information structure, Tech. Commun., 40 (4): 638–654, 1993.
- 27 P. Benson Writing visually: Design considerations in technical publications, Tech. Commun., 32 (4): 35–39, 1985.
- 28 J. S. Dumas J. C. Redish A Practical Guide to Usability Testing, Exeter, UK: Intellect, Ltd. 1993.
- 29 J. Rubin Handbook of Usability Testing, New York: Wiley, 1994.
Citing Literature
Wiley Encyclopedia of Electrical and Electronics Engineering
Browse other articles of this reference work:
