28
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 17:54, 28 November 2023
, 11 months agoAdded a section on Research
(→User Experience: Added content to Usability, fixed short citations, made dashes to semicolons on Responsive Design list) |
(Added a section on Research) |
||
| Line 10: | Line 10: | ||
=== Characteristics of Technical Communication === | === Characteristics of Technical Communication === | ||
Technical communication is meant to guide an audience and must be easily understood. Successful technical documentation is accurate, logically sound, and appropriate.{{sfn|Perelman|1998}} Communication can be said to be accurate in two different understandings: accurate in description and accurate in content. Accurate descriptions are easy to understand. Accurate content provides for the intended result. Communication delivered logically is well-organized, clear, and will be coherent for most users. Technical information that is appropriate contains elements and steps that are suitable for the intended purpose and audience. | Technical communication is meant to guide an audience and must be easily understood. Successful technical documentation is accurate, logically sound, and appropriate.{{sfn|Perelman|1998}} Communication can be said to be accurate in two different understandings: accurate in description and accurate in content. Accurate descriptions are easy to understand. Accurate content provides for the intended result. Communication delivered logically is well-organized, clear, and will be coherent for most users. Technical information that is appropriate contains elements and steps that are suitable for the intended purpose and audience. | ||
===Importance of Research=== | |||
Major decisions in any organization are based upon research providing results where critical thinking has been applied. Technical communicators must work with subject matter experts, but also must conduct in-depth independent research for every product. The stages of critical thinking in the research process are:<ref>{{cite book |last=Lannon |title=Technical Communication |page=145 |year=2022}}</ref> | |||
*Asking the right questions. The right questions help define the research problem. The answers found in research are only as good as the questions asked. | |||
*Exploring a balance of views. This provides a broad "range" of evidence. Ask: What do informed sources say about the topic? On which points do sources agree or disagree? Which sources carry more weight than others? | |||
*Providing adequate "depth" into the topic through thorough research. Surface level is reached through popular media. The next level is reached through trade, business, and technical publications. The deepest level is reached through specialized literature such as peer-reviewed journals, government sources, and corporate documents. | |||
*Evaluating the findings. Search for bias in the research. Look for the accurate answer. | |||
*Interpreting the findings. Ensure the final report answers the original research problem. | |||
The ability to adequately, accurately, and completely research a subject prior to writing technical communication dictates the writer's success. | |||
==Historical Context== | ==Historical Context== | ||