339
edits
m (→Bibliography: Author-mask should be used when repeating an author. This is an example.) |
m (Underlining should NEVER be used. Who can tell me why?) |
||
Line 38: | Line 38: | ||
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. | ||
==== | ====Standards Compliant==== | ||
Many technical fields have industry-specific regulations and guidelines determined by governing bodies that impact their technical communication. Furthermore, many organizations may have a style guide that outlines preferred language usage, tone, and formatting.{{sfn|Smirti|2022}} | Many technical fields have industry-specific regulations and guidelines determined by governing bodies that impact their technical communication. Furthermore, many organizations may have a style guide that outlines preferred language usage, tone, and formatting.{{sfn|Smirti|2022}} | ||