90
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 09:56, 20 November 2023
, 1 year agoReorganizing and expanding Technical Documents section.
Debbiebwolfe (talk | contribs) m (→Blogs: Added more information to blog definition and additional citations.) |
Debbiebwolfe (talk | contribs) (Reorganizing and expanding Technical Documents section.) |
||
| Line 4: | Line 4: | ||
==Overview== | ==Overview== | ||
=== Aims of Technical Communication === | === Aims of Technical Communication === | ||
| Line 14: | Line 10: | ||
=== Characteristics of Technical Communication === | === Characteristics of Technical Communication === | ||
Because technical communication is intended to guide an audience, it must be assembled in such a way that it is very 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 that is delivered logically is well-organized and clear and can be approached in a manner that will be coherent for most users. Technical information that is appropriate contains elements and steps that are suitable for the intended purpose and audience. | Because technical communication is intended to guide an audience, it must be assembled in such a way that it is very 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 that is delivered logically is well-organized and clear and can be approached in a manner that 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 Documents == | |||
Technical writing encompasses various genres and styles, influenced by the information and discourse communities. Not all technical documents are produced by technical writers, as professionals produce various technical documents.{{sfn|Lannon|Gurak|2020|p=32}} | |||
Common types of technical communication include:{{sfn|Mussack|2021}} | |||
instructions, user guides, reports, proposals, memos, and procedures. | |||
== Features of Technical Communication == | == Features of Technical Communication == | ||