5
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 22:04, 1 December 2023
, 5 months ago→Clear and Concise
(→Document Design: Added structure to the document design section.) |
|||
| Line 53: | Line 53: | ||
=====Clear and Concise===== | =====Clear and Concise===== | ||
Technical communication includes a well-structured document. Technical communication should be logically organized, straightforward, and easily understood by the target audience. Planning the document structure allows the technical writer to define the purpose, scope, and main points of the document. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and/or excessive explanations. Using heading’s sub-headings, and lists allows the writer to structure the document into a coherent order. A table of contents or an outline allows readers to navigate a document.{{sfn|Proofed Editors|2020}}[https://www.linkedin.com/advice/0/how-do-you-write-clear-technical-documents-clients-skills-writing] | Technical communication includes a well-structured document. Technical communication should be logically organized, straightforward, and easily understood by the target audience. Planning the document structure allows the technical writer to define the purpose, scope, and main points of the document. The language used should avoid needless jargon and be written in a manner that avoids redundant word usage and/or excessive explanations. Using heading’s sub-headings, and lists allows the writer to structure the document into a coherent order. A table of contents or an outline allows readers to navigate a document.{{sfn|Proofed Editors|2020}}<ref>[https://www.linkedin.com/advice/0/how-do-you-write-clear-technical-documents-clients-skills-writing#know-your-audience]</ref> | ||
====Formatted and Organized==== | ====Formatted and Organized==== | ||