32
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 22:05, 1 December 2023
, 11 months ago→Technical Communication Strategies: Edits for conciseness, punctuation, and capital/lower case standards
(→Technical Communication Strategies: Edits for conciseness, punctuation, and capital/lower case standards) |
|||
| Line 41: | Line 41: | ||
=='''Technical Communication Strategies'''== | =='''Technical Communication Strategies'''== | ||
==='''Characteristics of Technical Communication'''=== | ==='''Characteristics of Technical Communication'''=== | ||
Technical communication is meant to guide an audience and must be easily understood. Successful technical documentation is accurate, logically sound, and appropriate.{{sfn|Perelman|1998}} Communication can be | Technical communication is meant to guide an audience and must be easily understood. Successful technical documentation is accurate, logically sound, and appropriate.{{sfn|Perelman|1998}} Communication can be accurate in description and content. Accurate descriptions are easy to understand. Accurate content provides for the intended result. Communication delivered logically is well-organized, clear, and will be coherent for most users. Appropriate technical information contains elements and steps suitable for the intended purpose and audience.{{sfn|Perelman|1998}} | ||
====Standards Compliant==== | ====Standards Compliant==== | ||
| Line 68: | Line 68: | ||
==='''Examples of Technical Documents'''=== | ==='''Examples of Technical Documents'''=== | ||
Technical writing encompasses various genres and styles | Technical writing encompasses various genres and styles influenced by the information and discourse communities. Not all technical documents are produced by technical writers, as many professionals create various technical documents.{{sfn|Lannon|Gurak|2020|p=32}} | ||
Common types of technical communication include:{{sfn|Mussack|2021}} | Common types of technical communication include:{{sfn|Mussack|2021}} | ||
| Line 101: | Line 101: | ||
====Press Releases==== | ====Press Releases==== | ||
A press release can be an announcement or | A press release can be an organization's announcement or latest news distributed to media outlets with information for the public. A press release can be called a press statement, news release, or media release.{{sfn|Pradhan|2021}} | ||
====Proposals==== | ====Proposals==== | ||
| Line 112: | Line 112: | ||
Informal or brief reports provide an objective overview of an organization's current state, past events, and future plans, ensuring that readers are well-informed about the organization's operations. Some examples include{{sfn|Johnson-Sheehan|2018|pp=285-288}}: | Informal or brief reports provide an objective overview of an organization's current state, past events, and future plans, ensuring that readers are well-informed about the organization's operations. Some examples include{{sfn|Johnson-Sheehan|2018|pp=285-288}}: | ||
*Progress | *Progress reports are used to inform management about the progress or status of a project. | ||
* White papers and | * White papers and briefings educate management or clients about important issues. | ||
*Incident | *Incident reports objectively focus on presenting facts relating to an accident or irregular occurrence. | ||
*Laboratory | *Laboratory reports describe experiments, tests, or inspections. | ||
=====Formal Reports===== | =====Formal Reports===== | ||
| Line 130: | Line 130: | ||
Skills resumes provide employment history, but the primary focus is to highlight how an individual applied distinct skills and experiences across various professional positions.{{sfn|Markel|Selber|2019|pp=411-412}} | Skills resumes provide employment history, but the primary focus is to highlight how an individual applied distinct skills and experiences across various professional positions.{{sfn|Markel|Selber|2019|pp=411-412}} | ||
====User | ====User Guides==== | ||
A user guide is an instructional manual created to help consumers use the product, service or system. A user guide typically includes step-by-step instructions.{{Sfn|Wainaina|2022}} | A user guide is an instructional manual created to help consumers use the product, service or system. A user guide typically includes step-by-step instructions.{{Sfn|Wainaina|2022}} | ||