32
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 00:43, 1 December 2023
, 5 months ago→Examples of Technical Documents: Removed bold formatting as to be consistent with other subheadings
m (removed redundant sentence) |
m (→Examples of Technical Documents: Removed bold formatting as to be consistent with other subheadings) |
||
| Line 69: | Line 69: | ||
Common types of technical communication include:{{sfn|Mussack|2021}} | Common types of technical communication include:{{sfn|Mussack|2021}} | ||
==== | ====Case Studies==== | ||
Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data.{{sfn|Johnson-Sheehan|2018|pp=401-404}} | Case studies are a form of empirical or observational research that consists of in-depth examination of distinct individuals, groups, events, or scenarios. This research can be used to generate qualitative or quantitative data.{{sfn|Johnson-Sheehan|2018|pp=401-404}} | ||
==== | ====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|Industrial Data Associates|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|Industrial Data Associates|2020|p=}} | ||
==== | ====Descriptions==== | ||
Descriptions are concise explanations of procedures and processes that assist readers in understanding how something works. Product descriptions and process descriptions are the two main types of technical descriptions.{{sfn|Lannon|Gurak|2020|pp=443-453}} | Descriptions are concise explanations of procedures and processes that assist readers in understanding how something works. Product descriptions and process descriptions are the two main types of technical descriptions.{{sfn|Lannon|Gurak|2020|pp=443-453}} | ||
| Line 81: | Line 81: | ||
*Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome. | *Process: provides step-by-step instructions on how to perform a particular task or achieve a specific outcome. | ||
==== | ====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}} | ||
| Line 87: | Line 87: | ||
*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}} | ||
==== | ====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}} | ||
==== | ====Letters==== | ||
Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically.{{sfn|Johnson-Sheehan|2018|p=139}} | Letters are a traditional form of communication most often used by employees to communicate with individuals outside of a company or organization. They are typically written on company letterhead. Today, letters are sent either by U.S. mail or electronically.{{sfn|Johnson-Sheehan|2018|p=139}} | ||
==== | ====Memos==== | ||
A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization.{{sfn|Lannon|Gurak|2020|p=353}} | A memo (short for memorandum) is an official communication, usually a message from the company, a manager or director, or another person or group acting in an official capacity, used to communicate with others within the same organization.{{sfn|Lannon|Gurak|2020|p=353}} | ||
==== | ====Press Releases==== | ||
A press release can be an announcement or recent news that is distributed to media outlets from a company, with intentions on spreading the information to the general public. A press release can be called a press-statement, news release or media release.{{sfn|Pradhan|2021}} | A press release can be an announcement or recent news that is distributed to media outlets from a company, with intentions on spreading the information to the general public. A press release can be called a press-statement, news release or media release.{{sfn|Pradhan|2021}} | ||
==== | ====Proposals==== | ||
A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan|2018|p=245}} | A proposal is a document that identifies an existing problem or opportunity and outlines a comprehensive strategy for addressing it. Organizations create ''internal'' proposals to describe programs and projects that meet specific operational needs, such as a plan to replace an outdated software system. Companies develop ''external'' proposals for potential customers or clients. These documents detail new products, services, or initiatives that a company will implement to address a specific customer concern.{{sfn|Johnson-Sheehan|2018|p=245}} | ||
==== | ====Reports==== | ||
A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports.{{sfn|Johnson-Sheehan|2018|loc=chpt 10 & 11}} | A report is a concise, easily understandable document that presents technical information in a clear, organized format, allowing readers to access varying levels of information. Reports are categorized as informal, such as briefs, and formal, such as research, scientific, and completion reports.{{sfn|Johnson-Sheehan|2018|loc=chpt 10 & 11}} | ||