56
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 19:57, 20 November 2023
, 1 year ago→Documentation: Added & fixed citation
Beth Kennedy (talk | contribs) m (→Documentation: Added & fixed citation) |
|||
| Line 24: | Line 24: | ||
==== Documentation ==== | ==== Documentation ==== | ||
Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows: | Documentation comprises various texts that allow users to accomplish tasks or gain information. It generally falls into three categories, which can be defined as follows: | ||
* Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti|2022|p=167}} | * Instructions: Text that describes how to complete a task, often offering numbered steps. Examples include how to download software or assemble a product.{{sfn|Balzotti |2022|p=167}} | ||
* Specifications: Communications that deliver technical details on how a product is put together or a specific operation is executed. Also known as "specs," these texts may be written by engineers or technicians. | * Specifications: Communications that deliver technical details on how a product is put together or a specific operation is executed. Also known as "specs," these texts may be written by engineers or technicians.{{sfn|Johnson-Sheehan |2018|p=205}} | ||
* Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan |2018|p=205}} | * Procedures and Protocols: Guidelines to ensure consistency, quality, and safety in the workplace. For example, a hospital may provide staff with procedures on how to adapt operations during an emergency, such as a power outage.{{sfn|Johnson-Sheehan |2018|p=205}} | ||