{"id":140,"date":"2020-07-23T18:55:44","date_gmt":"2020-07-23T18:55:44","guid":{"rendered":"https:\/\/courses.lumenlearning.com\/suny-esc-technicalwriting\/?post_type=chapter&p=140"},"modified":"2020-11-12T17:22:32","modified_gmt":"2020-11-12T17:22:32","slug":"conventions-for-integrating-visuals-into-technical-documents","status":"publish","type":"chapter","link":"https:\/\/courses.lumenlearning.com\/suny-esc-technicalwriting\/chapter\/conventions-for-integrating-visuals-into-technical-documents\/","title":{"raw":"Integrating Visuals into Technical Documents","rendered":"Integrating Visuals into Technical Documents"},"content":{"raw":"

General Practices for Tables & Figures<\/h2>\r\n\"\"\r\n\r\nOther pages in this section refer to some of these guidelines. However, integrating visuals into text is important enough to warrant a summary of common guidelines for using visuals.\r\n

Placing Visuals within a Document<\/h3>\r\nIdentify places in text where visuals will increase your communication's usability and persuasiveness. In general, put visuals as close as possible to their accompanying text, but make sure that they do not alter the flow of the text. Introduce each visual in the text first, and always make sure that visuals have accompanying text; no visual should stand alone. Visuals enhance text.\r\n

Title Placement for Visuals<\/h3>\r\nPlace table titles above the table, since we read from top to bottom. Place figure titles below the figure, since a reader's eye will go to the image first before the text.\r\n

Numbering Visuals<\/h3>\r\nNumber the titles so that there's a clear relationship between the visual and the text information the visual represents. For most documents, use regular numbers in sequence (not roman numerals or letters), for example Table 1, Table 2, Figure 1, Figure 2. If you have a very lengthy technical document with a large number of sections and a large number of visuals in each section, you may label by section, e.g., Table 1.3, Table 2.6, Figure 1.7, Figure 4.4.\r\n

Citing Visuals<\/h3>\r\nIf you've taken a visual from another source, include a footnote at the end of the title, and the full citation at the end of the page or the document. You may also opt to mention that source as part of the title; you still need the footnote in most cases.\r\n

Referring to Visuals<\/h3>\r\nWhenever you use a chart or graph, refer to it in your text by number and\/or name. Do not refer to it by location (\"the photograph above\" or \"the table below\").\r\n

Explaining Visuals in the Text<\/h3>\r\nYour text usually offers fuller explanation, analysis of, and\/or conclusions drawn from the information provided in the visual. Remember that visuals provide information in shorter form; your text provides information in full.\r\n
\r\n

sample chart integrated into text<\/h3>\r\nNote that the text immediately before and after the chart calls attention to the chart and briefly indicates its significance.\r\n\r\n \r\n\r\nIn recent benchmark tests performed by PC Magazine, all three of the systems compared here performed at or near the same levels. [1]<\/sup> The Micron system comes out on top with slightly better average scores, as shown in Figure 5.\r\n\r\n\"\"\r\n

Figure 5. Benchmark ratings of system performance [1]<\/sup><\/p>\r\nIt is important to note that the Gateway P5 system used in these tests was equipped with 256K Pipeline Burst cache\u2014a feature not present in the basic configuration noted in Figure 5. The lack of secondary cache in Pentium systems is widely regarded to result in a decrease in system performance of up to 30%.\r\n\r\n<\/div>\r\n

Level of Information in Visuals<\/h3>\r\nMake sure your visuals are appropriate to your audience, subject matter, and purpose. Don't overload non-technical audiences with highly technical information in visuals.\r\n

Clarity<\/h3>\r\nMake sure visuals are clear and easy to read. Text within a visual should be sized appropriately.\r\n
<\/figure>","rendered":"

General Practices for Tables & Figures<\/h2>\n

\"\"<\/p>\n

Other pages in this section refer to some of these guidelines. However, integrating visuals into text is important enough to warrant a summary of common guidelines for using visuals.<\/p>\n

Placing Visuals within a Document<\/h3>\n

Identify places in text where visuals will increase your communication’s usability and persuasiveness. In general, put visuals as close as possible to their accompanying text, but make sure that they do not alter the flow of the text. Introduce each visual in the text first, and always make sure that visuals have accompanying text; no visual should stand alone. Visuals enhance text.<\/p>\n

Title Placement for Visuals<\/h3>\n

Place table titles above the table, since we read from top to bottom. Place figure titles below the figure, since a reader’s eye will go to the image first before the text.<\/p>\n

Numbering Visuals<\/h3>\n

Number the titles so that there’s a clear relationship between the visual and the text information the visual represents. For most documents, use regular numbers in sequence (not roman numerals or letters), for example Table 1, Table 2, Figure 1, Figure 2. If you have a very lengthy technical document with a large number of sections and a large number of visuals in each section, you may label by section, e.g., Table 1.3, Table 2.6, Figure 1.7, Figure 4.4.<\/p>\n

Citing Visuals<\/h3>\n

If you’ve taken a visual from another source, include a footnote at the end of the title, and the full citation at the end of the page or the document. You may also opt to mention that source as part of the title; you still need the footnote in most cases.<\/p>\n

Referring to Visuals<\/h3>\n

Whenever you use a chart or graph, refer to it in your text by number and\/or name. Do not refer to it by location (“the photograph above” or “the table below”).<\/p>\n

Explaining Visuals in the Text<\/h3>\n

Your text usually offers fuller explanation, analysis of, and\/or conclusions drawn from the information provided in the visual. Remember that visuals provide information in shorter form; your text provides information in full.<\/p>\n

\n

sample chart integrated into text<\/h3>\n

Note that the text immediately before and after the chart calls attention to the chart and briefly indicates its significance.<\/p>\n

 <\/p>\n

In recent benchmark tests performed by PC Magazine, all three of the systems compared here performed at or near the same levels. [1]<\/sup> The Micron system comes out on top with slightly better average scores, as shown in Figure 5.<\/p>\n

\"\"<\/p>\n

Figure 5. Benchmark ratings of system performance [1]<\/sup><\/p>\n

It is important to note that the Gateway P5 system used in these tests was equipped with 256K Pipeline Burst cache\u2014a feature not present in the basic configuration noted in Figure 5. The lack of secondary cache in Pentium systems is widely regarded to result in a decrease in system performance of up to 30%.<\/p>\n<\/div>\n

Level of Information in Visuals<\/h3>\n

Make sure your visuals are appropriate to your audience, subject matter, and purpose. Don’t overload non-technical audiences with highly technical information in visuals.<\/p>\n

Clarity<\/h3>\n

Make sure visuals are clear and easy to read. Text within a visual should be sized appropriately.<\/p>\n

<\/figure>\n\n\t\t\t
\n\t\t\t

Candela Citations<\/h3>\n\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t\t
CC licensed content, Original<\/div>