Technical Writing in the Digital Age: Difference between revisions

→‎Document Design: Added structure to the document design section.
(→‎Document Design: Added structure to the document design section.)
Line 65: Line 65:


====Document Design====
====Document Design====
The appropriateness of documents requires readers to understand the document's message quickly. The document should be of appropriate style and length for the readers' needs.
Plan the structure of a document so that it is easy to follow and understand. Planning the document structure includes defining a purpose, breadth, and main subjects. Organize the document into a logical and clear order that maintains the purpose of the article. Headings, subheadings, and lists provide coherence to a technical paper. <ref>[https://www.linkedin.com/advice/0/how-do-you-write-clear-technical-documents-clients-skills-writing#know-your-audience]</ref> The appropriateness of documents requires readers to understand the document's message quickly. The document should be of appropriate style and length for the readers' needs.


==='''Examples of Technical Documents'''===
==='''Examples of Technical Documents'''===