Jump to content

Technical Writing in the Digital Age: Difference between revisions

→‎Technical Documents: Added entry for Documentation and moved Instructions and Procedures under it
(Added definition and citation.)
(→‎Technical Documents: Added entry for Documentation and moved Instructions and Procedures under it)
Line 21: Line 21:
==== Data Sheets ====
==== Data Sheets ====
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology. {{sfn|IDA|2020|p=}}
A data sheet, also known as a technical datasheet, is a document used to describe and summarize the characteristics of a product, material, component, or technology. {{sfn|IDA|2020|p=}}
==== 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:
* Instructions: Text that describes how to complete a task, often offering a step-by-step process. Examples include how to download software or assemble a product.
* 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.
* 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}}
==== Email ====
==== Email ====
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon & Gurak |2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon & Gurak |2020|p=348}}
Emails are the primary form of communication in the workplace, used for both internal and external communication. They facilitate information exchange, idea exchange, and activity coordination.{{sfn|Lannon & Gurak |2020|p=335}} Emails should be brief, concise, readable, and targeted to specific audiences with specific subject lines.{{sfn|Lannon & Gurak |2020|p=348}}
==== Instructions & Procedures ====


==== Letters ====
==== Letters ====
56

edits