Technical Writing in the Digital Age: Difference between revisions

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|p=401-404}}

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}}

* 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.{{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}}

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 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}}

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 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|p=Chap 10 & 11}}

Résumés offer an overview of an individual’s educational credentials and professional experience and often are used to demonstrate an applicant’s qualifications to potential employers. {{sfn|Johnson-Sheehan |2018|p=100}} They may be organized in various ways, but two common approaches are chronologically and by skills. Chronological résumés demonstrate the sequence of education and employment history and detail a person’s tasks, responsibilities, and achievements in each successive role. Skills résumés 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|p=411-412}}