90
edits
Technical Writing in the Digital Age: Difference between revisions
Technical Writing in the Digital Age (view source)
Revision as of 11:56, 21 November 2023
, 7 months ago→Reports
Debbiebwolfe (talk | contribs) (→Technical Documents: Added definition and citation.) |
Debbiebwolfe (talk | contribs) m (→Reports) |
||
| 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|p=Chap 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|p=Chap 10 & 11}} | ||
===== Informal 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: | 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: | ||
* Progress reports inform management about the progress or status of a project. | * Progress reports inform management about the progress or status of a project. | ||
* White papers educate management or clients about important issues. | * White papers educate management or clients about important issues. | ||
===== Formal Reports ===== | |||
A formal report is a factual and data-driven response to a research question. | A formal report is a factual and data-driven response to a research question. | ||
* Research reports present the findings of a study. | * Research reports present the findings of a study. | ||
* Scientific research reports outline the process, progress, and results of technical or scientific research or the current state of a research problem. | * Scientific research reports outline the process, progress, and results of technical or scientific research or the current state of a research problem. | ||
* Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client. | * Completion reports assess the outcomes of a project or initiative and provide feedback to management or the client. | ||