|
Technical documents can contain the following types of figures: photographs, screen captures, scaled drawings (for example, plans, cross sections, and 3D views), and diagrams. With the exception of diagrams, they all show a representation of something that exists in reality, or will exist. A diagram, on the other hand, shows something that does not exist physically; for example, statistical data, or concepts that exist only in our minds.To show statistical data, we can use standard diagrams such as pie charts and graphs. This page does not describe methods for showing statistical data: instead it looks at creating diagrams that show concepts. For example, sequences and relationships. I suppose its possible to argue that concepts do in fact exist – as mental pictures. In which case, when creating an effective diagram, the skill is putting the mental picture onto paper or screen so that the reader obtains exactly the same information. In the Picture This section lists ten types of information that diagrams can communicate. Often, a diagram conveys more than a single type of information. I have derived this list by analysing how I have used diagrams in my own work so I dont claim that it is complete.Diagrams can show:1. what something is. For example, during a seismic survey, sound waves travel through the earths crust. The sound can travel along different path types, each having a specific name depending on how many times the sound is reflected and where the reflections take place. For each path type, a diagram can show where the sound travels. 2. what something does. For a computer program that reformats data, a diagram can show the structure of the input data and the output data. 3. the context. In a manual for a product that is used in only some departments in a company, a diagram can show the complete structure of the company and show which departments use the product and for what purpose. 4. an overview. In an early chapter in a manual for a product, a diagram can show all the main functions or components of the product, often with cross-references to where the topics are described in detail. 5. a picture of the words. This use of a diagram is appropriate for spatial information, 2-dimensional or 3-dimensional. Even if the reader can get all the information from the words, the diagram provides reassurance and also makes it easier to recap the information. 6. components. A computer model of a road network comprises several components. In simple terms, there are several types of point and several types of line. A diagram can easily show these components. 7. comparisons. This use of a diagram is very helpful when there are several things that are fundamentally the same but have subtle differences. For example, the sound-wave paths I mentioned earlier in what something is.
8. relationships. A diagram that shows components is also likely to show the relationships between the components. A computer program often uses several files; a diagram can easily indicate, for example, input files and output files. 9. sequences. This is a common use of diagrams and it enables authors to show the correct order for a sequence of events or tasks. 10. which item to select. This type of diagram steers the reader through the diagram to one of several end points. The diagram contains questions in decision boxes. At the first box, the reader selects one of the boxs answers and then follows the corresponding arrow, which leads to the next question, and so on. Its worth repeating that many diagrams convey more than one type of information: most of mine do.Secondary Benefits for Readers Although the main reason for using diagrams is to communicate information, there are other benefits for readers because diagrams also do the following:• make documents more appealing. This means readers are more likely to use the document in the first place. Moreover, they will maintain interest and receptivity longer. • provide anchorages. In technical reference material, a topic might take several hours to read. This reading is unlikely to be continuous; diagrams make it easier for readers to pick up the thread again after a break. • help navigation. Readers often remember diagrams and, for paper documents, its easy to flick through a document and find a diagram. Hence, particularly when a reader is familiar with a document, this method can be quicker than using an index. Diagrams Close the Knowledge Gap Using diagrams also provides benefits for authors:• highlight gaps in authors knowledge. On many occasions, I have thought that I fully understood something and then, as soon as I tried to produce a diagram, I found that there were gaps in my knowledge about the topic. • help research. I automatically create diagrams while I am researching a topic. Moreover, I find its essential to use these diagrams as the focal points of discussions with experts. As a rider to this point, it seems obvious that I must subsequently include these diagrams in the document — if these diagrams are essential for me to learn about the topic, they will also be essential for my readers. Value Beyond Illustration Diagrams, it seems, do more than replace a thousand words. They provide several benefits that go well beyond merely illustrating an idea or an object. These may not be instantly apparent but to the reader, author and to the companies that own them these benefits make a document infinitely though invisibly more valuable and useful.All articles on the Quality Authors web site are copyright and are the property of the authors, who have asserted their moral rights. For permission to use an article, please contact the author directly. |
