Technical Writing in the Digital Age: Difference between revisions

Technical Writing in the Digital Age (view source)

Revision as of 19:57, 26 November 2023

252 bytes added , 6 months ago

→‎Informal Reports: Added "Johnson-Sheehan" sfn and edited section for clarity.

Natecole54

145

edits

@@ Line 52: / Line 52: @@
 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}}
-===== Informal Reports =====
+===== Informal or Brief Reports =====
-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.  Brief reports are categorized into three subcategories:
+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 reports inform management about the progress or status of a project.
+* Progress Reports. These are used to inform management about the progress or status of a project.
-* White papers educate management or clients about important issues.
+* White papers and Briefings. These educate management or clients about important issues.
+* Incident Reports. These objectively focus on presenting facts relating to an accident or irregular occurrence.
+* Laboratory Reports. These describe experiments, tests, or inspections.
 ===== Formal Reports =====