100
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 23:29, 7 November 2023
, 10 months ago→Overview
| Line 11: | Line 11: | ||
| access-date =October 30, 2023 | | access-date =October 30, 2023 | ||
| ref = harv | | ref = harv | ||
}}</ref> In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally | }}</ref> In essence, technical writing in the digital age encapsulates the art and science of conveying technical information in a manner that is comprehensible and accessible to diverse audiences in our digitally driven society. <ref>{{cite web | ||
| url = https://grlucas.net/grl/CompFAQ/Technical_Writing | | url = https://grlucas.net/grl/CompFAQ/Technical_Writing | ||
| title = Defining Technical Writing | | title = Defining Technical Writing | ||
| Line 40: | Line 40: | ||
}}</ref> | }}</ref> | ||
<ref>Mussack, Brigitte. (2021). Introduction to Technical and Professional Communication: Technical Communication through a Social Justice Lens. Creative Commons Attribution NonCommercial, 2021. n.p.</ref> | <ref>Mussack, Brigitte. (2021). Introduction to Technical and Professional Communication: Technical Communication through a Social Justice Lens. Creative Commons Attribution NonCommercial, 2021. n.p.</ref> | ||
=== Aims of Technical Communication === | |||
As much as technical communication is a discipline in and of itself, it also exists within many other disciplines. Examples of technical communication can be found among such fields as varied as education, business, and science. Technical documentation within any domain typically embodies a similar aim: to help its audience act toward some sort of task or goal. | |||
=== 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, logical, and appropriate. Communication can be said to be accurate in two different understandings: accurate in description and accurate in information. Accurate descriptions will be clear to understand. Accurate information will provide the intended result. Communication that is delivered logically will be very clear and direct and can be approached in a manner that will be coherent for most users. Technical information that is appropriate will contain elements and steps that will be suitable for the intended purpose and audience. | |||
=== Features of Technical Communication === | |||
There are many features of technical communication which lead to it being accurate, sound, and appropriate. | |||
==== '''Accuracy''' ==== | |||
===== ''Standards Compliant'' ===== | |||
Many technical fields have industry specific regulations and guidelines which are determined by governing bodies and that also have an impact on their technical communication. | |||
===== ''Detailed'' ===== | |||
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies. | |||
''Objective'' | |||
Objective communication is presented in an unbiased and impartial manner and is free of personal opinions. It relies upon facts and evidence and avoids an overly emotional tone. | |||
''Concise'' | |||
Good technical communication expresses meaning in a way that is straightforward and that avoids redundant words or excessive explanations. It should be easy to absorb and process. | |||
''Clear'' | |||
Clear language is organized logically, is not unnecessarily involved, and is easily understood by the target audience. It will avoid unnecessary jargon and complexity. | |||
==== '''Soundness''' ==== | |||
''Format'' | |||
Technical documents should be formatted in a way that is consistent with the norms and standards of applicable professional fields. Additionally, formatting should adhere to guidelines which enhance usability. | |||
''Visuals'' | |||
Technical communication utilizes visuals strategically to facilitate understanding of textual content. When presented properly, they can elucidate difficult concepts and make material accessible to a more diverse audience. | |||
==== '''Appropriateness''' ==== | |||
''Audience-specific'' | |||
Where possible, technical communication should be customized to align with the knowledge and needs of its audience. | |||
==Historical Context== | ==Historical Context== | ||
===Technical Writing Profession=== | ===Technical Writing Profession=== | ||