Issues of Content and Presentation in Document Design

Publisher Summary This chapter focuses on the issues of content and presentation in document design. Computer documentation includes many different categories of information, ranging from specific details of how to link up the hardware to general advice on how to get the best out of a sophisticated software application. Both kinds of information can be considered as advice to the user, but advice can inform, explain, or recommend. This range of functions varies from introductory tutorials for newcomers to the quick reference guides for those who know their way around the system and only need brief reminders of appropriate procedures or commands. Between these two extremes come other kinds of explanatory notes and reference manuals, sometimes intended for specialist users such as programmers and maintenance engineers. Within this variation in the function of documentation, there is also considerable variation in the medium of communication.

[1]  G. Reed Agnew Writing Backwards: The Use of Visual Models in Writing. , 1986 .

[2]  T.F.M. Stewart Eyestrain and visual display units: a review , 1979 .

[3]  W Winn,et al.  Perceptual Strategies Used with Flow Diagrams Having Normal and Unanticipated Formats , 1983, Perceptual and motor skills.

[4]  Keith Duncan,et al.  Cognitive Engineering , 2017, Encyclopedia of GIS.

[5]  F. Schmalhofer,et al.  Three components of understanding a programmer's manual: Verbatim, propositional and situational representations , 1986 .

[6]  John M. Carroll,et al.  Exploring Exploring a Word Processor , 1985, Hum. Comput. Interact..

[7]  David E. Kieras,et al.  The Role of a Mental Model in Learning to Operate a Device , 1990, Cogn. Sci..

[8]  D. J. Pullinger,et al.  Enhancing NOTEPAD teleconferencing for the BLEND electronic journal , 1984 .

[9]  D. Gentner,et al.  A framework for a cognitive theory of writing , 1980 .

[10]  J. Pepper Following Students' Suggestions for Rewriting a Computer Programming Textbook , 1981 .

[11]  C. Lewis A model of mental model construction , 1986, CHI '86.

[12]  B. K. Britton,et al.  Effects of Text Structure on Use of Cognitive Capacity during Reading. , 1982 .

[13]  Naomi Miyake Constructive interaction and the iterative process of understanding , 1986 .

[14]  Ian H. Witten,et al.  Elements of Computer Typography , 1985, Int. J. Man Mach. Stud..

[15]  R. J. Glushko,et al.  Automated Repair Service Bureau: On-line documentation: Mechanizing development, delivery, and use , 1982, The Bell System Technical Journal.

[16]  Mohammad M.A.H.,et al.  Factors Affecting the Successful Reading of Technical Instructions. , 1984 .

[17]  P. Wright,et al.  Detour Routes to Usability: A Comparison of Alternative Approaches to Multipurpose Software Design , 1983, Int. J. Man Mach. Stud..

[18]  Patricia Wright,et al.  Multi-Window Displays for Readers of Lengthy Texts , 1987, Int. J. Man Mach. Stud..

[19]  D. Stone,et al.  How Do Young Adults Read Directions with and without Pictures , 1981 .

[20]  Brian R. Gaines,et al.  Editorial: Knowledge Acquisition , 1987, Int. J. Man Mach. Stud..

[21]  Patricia Wright,et al.  Usability: The criterion for designing written information , 1980 .

[22]  Donald A. Norman,et al.  Stages and Levels in Human-Machine Interaction , 1984, Int. J. Man Mach. Stud..

[23]  J. P. Kincaid,et al.  The Computer Readability Editing System , 1981, IEEE Transactions on Professional Communication.

[24]  D. Kieras Initial mention as a signal to thematic content in technical passages , 1980, Memory & cognition.

[25]  Bertram C. Bruce,et al.  Why readability formulas fail , 1981, IEEE Transactions on Professional Communication.

[26]  D. Broadbent,et al.  Implicit and explicit knowledge in the control of complex systems , 1986 .

[27]  L M Reder,et al.  The role of elaborations in learning a skill from an instructional text , 1985, Memory & cognition.

[28]  John R. Anderson Acquisition of cognitive skill. , 1982 .

[29]  Thomas P. Moran,et al.  Analogy considered harmful , 1982, CHI '82.

[30]  P. C. Wason THE RETENTION OF MATERIAL PRESENTED THROUGH PRECIS , 1962 .

[31]  Deborah A. Boehm-Davis,et al.  Documentation of Concurrent Programs , 1985 .

[32]  Patricia Wright,et al.  Some factors determining when instructions will be read , 1982 .

[33]  Peter Jackson,et al.  On the Application of Rule-Based Techniques to the Design of Advice-Giving Systems , 1984, Int. J. Man Mach. Stud..

[34]  D. Hakes,et al.  Sentence comprehension and relative pronouns , 1970 .

[35]  Stephen A. Weyer,et al.  The design of a dynamic book for information search , 1982 .

[36]  R. Lorch Effects on recall of signals to text organization , 1985 .

[37]  Yvonne Waern,et al.  Thinking aloud during reading: A descriptive model and its application , 1980 .

[38]  Ben Shneiderman Human-computer interaction research at the University of Maryland , 1986, SGCH.

[39]  Edwina L. Rissland Ingredients of Intelligent User Interfaces , 1984, Int. J. Man Mach. Stud..

[40]  Michael Twyman The graphic presentation of language , 1982 .

[41]  J. D. Gould,et al.  Doing the Same Work with Hard Copy and with Cathode-Ray Tube (CRT) Computer Terminals , 1984 .

[42]  D E Kieras,et al.  How Experts and Nonexperts Operate Electronic Equipment from Instructions. , 1984 .

[43]  Peter C. Whalley,et al.  An Experiment with a Simple Recorder of Reading Behaviour , 1975 .

[44]  Frederick J. Bethke,et al.  Improving the Usability of Programming Publications , 1981, IBM Syst. J..

[45]  James Hartley,et al.  A research strategy for text desigbers: The role of headings , 1985 .

[46]  L M Reder,et al.  Effects of spacing and embellishment on memory for the main points of a text , 1982, Memory & cognition.

[47]  R. T. Kellogg,et al.  Designing idea processors for document composition , 1986 .

[48]  David E. Kieras,et al.  Rules for Comprehensible Technical Prose: A Survey of the Psycholinguistic Literature. , 1985 .

[49]  J. M. Judisch,et al.  Effects of Manual Style on Performance in Education and Machine Maintenance , 1981, IBM Syst. J..

[50]  Walter Kintsch,et al.  Propositional and situational representations of text , 1985 .

[51]  B. Adelson When Novices Surpass Experts: The Difficulty of a Task May Increase With Expertise , 1984 .

[52]  J. Hartley The role of colleagues and text-editing programs in improving text , 1984, IEEE Transactions on Professional Communication.

[53]  Winston Bennett,et al.  Deriving ideal student models to propel intelligent tutoring systems , 1986 .

[54]  Donald A. Norman,et al.  Designing for error , 1987 .

[55]  David E. Kieras,et al.  Good and bad structure in simple paragraphs: Effects on apparent theme, reading time, and recal , 1978 .

[56]  Joyce Hannah Swaney Editing for Comprehension: Improving the Process through Reading Protocols. , 1981 .

[57]  John D. Gould,et al.  Composing Letters with Computer-Based Text Editors , 1981 .

[58]  Donald E. Broadbent,et al.  Human Control of a Simulated Economic System , 1978 .

[59]  John R. Anderson,et al.  A Comparison of Texts and their Summaries: Memorial Consequences. , 1980 .

[60]  Marshall A. Atlas The user edit: Making manuals easier to use , 1981 .

[61]  Robert C. Williges,et al.  Retrieval of HELP Information for Novice Users of Interactive Computer Systems , 1985 .

[62]  Kirk H. Smith,et al.  Training by Exploration: Facilitating the Transfer of Procedural Knowledge Through Analogical Reasoning , 1986, Int. J. Man Mach. Stud..

[63]  Lance A. Miller,et al.  Computers for Composition: A Stage Model Approach to Helping. , 1986 .

[64]  Thomas N. Huckin Prescriptive Linguistics and Plain English: The Case of "Whiz- Deletions.". , 1986 .

[65]  Robert Waller,et al.  Criticism, Alternatives and Tests: A Conceptual Framework for Improving Typography , 1975 .

[66]  Janet H. Walker Symbolics Sage: A Documentation Support System , 1984, COMPCON.

[67]  Claire E. O'malley Helping Users Help Themselves , 1986 .

[68]  Peter R. Newsted,et al.  Paper versus Online Presentations of Subjective Questionnaires , 1985, Int. J. Man Mach. Stud..

[69]  B. Ross Remindings and their effects in learning a cognitive skill , 1984, Cognitive Psychology.

[70]  P. Pirolli,et al.  The role of learning from examples in the acquisition of recursive programming skills. , 1985 .

[71]  James Hartley,et al.  The Role and Position of Summaries: some issues and data , 1979 .

[72]  Ben Shneiderman,et al.  The Structure of Information in Online and Paper Technical Manuals , 1985 .

[73]  D. Broadbent Levels, Hierarchies, and the Locus of Control* , 1977 .

[74]  R. Fowler,et al.  Effectiveness of highlighting for retention of text material. , 1974 .

[75]  Marc A. Sullivan,et al.  Human factoring a text editor manual , 1983 .

[76]  Richard M. Chisholm Selecting Metaphoric Terminology for the Computer Industry , 1986 .

[77]  Peter J. Brown Making Unix online documentation more effective , 1985, Microprocess. Microsystems.

[78]  D. Broadbent,et al.  On the Relationship between Task Performance and Associated Verbalizable Knowledge , 1984 .

[79]  Thomas M. Duffy Organising and utilizing document design options , 1981 .

[80]  Patricia Wright Writing Technical Information , 1987 .

[81]  Ben Shneiderman,et al.  The future of interactive systems and the emergence of direct manipulation , 1982 .

[82]  Paul Muter,et al.  The role of graphics in item selection from menus , 1986 .

[83]  L L Light,et al.  Memory for scripts in young and older adults , 1983, Memory & cognition.

[84]  Gregg T. Vesonder,et al.  Text generation and recall by high-knowledge and low-knowledge individuals , 1980 .

[85]  Robert E. Horn Results with Structured Writing Using the Information Mapping Writing Service Standards , 1985 .

[86]  Raymond S. Nickerson,et al.  Understanding sign: Some examples of knowledge-dependent language processing , 1981 .

[87]  Sidney L. Smith,et al.  Application of Guidelines for Designing User Interface Software , 1985 .

[88]  Philip Klahr,et al.  Advice-Taking and Knowledge Refinement: An Iterative View of Skill Acquisition , 1980 .

[89]  Thomas M. Duffy,et al.  Document Design for Technical Job Tasks: An Evaluation , 1983 .