Technical Writing in the Digital Age: Difference between revisions

Line 58: Line 58:
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies.
Accurate information that is delivered with precision and specificity is essential to providing communication that is unambiguous and free of discrepancies.


''Objective''
===== ''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.  
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''
===== ''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.  
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'' =====
 
Clear language is organized logically, is not unnecessarily involved, and is easily understood by the target audience. It will avoid unnecessary jargon and complexity.   
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''' ====
==== '''Soundness''' ====
''Format''


===== ''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.
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''
===== ''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.
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''' ====
==== '''Appropriateness''' ====
''Audience-specific''


===== ''Audience-specific'' =====
Where possible, technical communication should be customized to align with the knowledge and needs of its audience.
Where possible, technical communication should be customized to align with the knowledge and needs of its audience.


100

edits