64
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 13:32, 13 November 2023
, 1 year ago→Format: Updated to add more context
(→Format: Updated to add more context) |
|||
| Line 66: | Line 66: | ||
=== '''Soundness''' === | === '''Soundness''' === | ||
==== Format ==== | ==== Format and Organization ==== | ||
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. Information should be logically organized for easy reading comprehension. This may involve using headings, subheadings, bullet points, and numbered lists. A well-organized document enhances the effective transfer of knowledge. | ||
==== Visuals ==== | ==== Visuals ==== | ||