Difference between revisions of "What Tech Report Is"
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[File:Cnm-digital.png|400px|thumb|right|[[ | + | [[File:Cnm-digital.png|400px|thumb|right|[[CNMCyber suite]]s]][[What Tech Report Is]] (hereinafter, the ''Lectio'') is the [[lectio|lesson part]] of '''[[Technical Report Essentials]]''' [[lesson]] that introduces its participants to [[technical report]] concepts. This ''lesson'' belongs to the ''CNMCT Entrance'' section of [[CNMCyber Bootcamps]]. |
| Line 10: | Line 10: | ||
:Similarly to other [[report]]s, ''technical reports'' consist of [[report content]]s and [[metadata]]. Report's metadata particularly includes report's title, date, authors, owners, and so on. | :Similarly to other [[report]]s, ''technical reports'' consist of [[report content]]s and [[metadata]]. Report's metadata particularly includes report's title, date, authors, owners, and so on. | ||
| − | :[[SSUFI]] is one of many methods for report outlining. ''SSUFI'' is the acronym for [[ | + | :[[SSUFI]] is one of many methods for report outlining. ''SSUFI'' is the acronym for [[document summary|'''S'''ummary]], [[report stage-setting section|'''S'''tage-setting]], [[report undertaking section|'''U'''ndertaking]], [[report finding|'''F'''inding]], [[report interpretation|'''I'''nterpretation]]. |
| − | :The [[ | + | :The [[document summary|summary]] is the condensed presentation of the substance of the [[report content]]. It allows its reader to decide whether he or she is interested in further reading. The ''summary'' briefly answers the question, "What the report changes." |
:The [[report stage-setting section|stage-setting section]] describes the problem, background, situation, and/or the tasks for which the project or research was undertaken. This section answers the questions, "Who, where, when, and why undertook the research." | :The [[report stage-setting section|stage-setting section]] describes the problem, background, situation, and/or the tasks for which the project or research was undertaken. This section answers the questions, "Who, where, when, and why undertook the research." | ||
| Line 22: | Line 22: | ||
:The [[report interpretation|interpretation]] describes conclusions, solutions, and implications that can be derived from the [[report finding]]s, as well as discussions that, possibly, represent different opinions, and, if requested, recommendations for further courses of action. This section answers the question, "What people think the report changes." | :The [[report interpretation|interpretation]] describes conclusions, solutions, and implications that can be derived from the [[report finding]]s, as well as discussions that, possibly, represent different opinions, and, if requested, recommendations for further courses of action. This section answers the question, "What people think the report changes." | ||
| − | :The [[STAR | + | :The [[STAR Layout]] is often used in [[job interview]]s. ''STAR'' stands for '''''S'''ituation, '''T'''ask, '''A'''ction, '''R'''esult'' is. In comparison with [[SSUFI]], it skips the summary and interpretations, as well as divides the ''stage-setting'' into ''situation'' and ''task''. The summary can be skipped since the ''STAR''-outlined report is usually given in response to [[interviewer]]'s request. |
:[[White paper]]s can be defined as those [[technical report]]s that have been created to educate product customers. Because of their marketing purpose, these ''papers'' are usually written in simpler language than ''technical reports''. ''White papers'' may also include [[opinion statement]]s in any section; the technical reports tend to allow ''opinions'' only in the ''interpretation section.'' | :[[White paper]]s can be defined as those [[technical report]]s that have been created to educate product customers. Because of their marketing purpose, these ''papers'' are usually written in simpler language than ''technical reports''. ''White papers'' may also include [[opinion statement]]s in any section; the technical reports tend to allow ''opinions'' only in the ''interpretation section.'' | ||
===Key terms=== | ===Key terms=== | ||
| − | :[[Technical report]], [[scientific report]], [[report content]], [[SSUFI]], [[ | + | :[[Technical report]], [[scientific report]], [[report content]], [[SSUFI]], [[document summary]], [[report stage-setting section]], [[report undertaking section]], [[report finding]], [[report interpretation]], [[STAR Layout]] ([[situation, task, action, result]]), [[white paper]] |
===Closing=== | ===Closing=== | ||
| − | : | + | :Fill in the blanks: |
| + | :__________ papers is a type of [[technical report]] that can be created to educate product customers. | ||
The successor [[lectio]] is '''[[Tech Report Metadata]]'''. | The successor [[lectio]] is '''[[Tech Report Metadata]]'''. | ||
Latest revision as of 02:53, 21 October 2023
What Tech Report Is (hereinafter, the Lectio) is the lesson part of Technical Report Essentials lesson that introduces its participants to technical report concepts. This lesson belongs to the CNMCT Entrance section of CNMCyber Bootcamps.
Content
The predecessor lectio is Narrated Fact vs Opinion.
Script
- A technical report is any report that presents those findings that are obtained while undertaking a research or another project. As documents, technical reports are similar to scientific reports. However, scientific reports are independently reviewed, usually by peers, before their publication, while technical reports rarely are.
- Similarly to other reports, technical reports consist of report contents and metadata. Report's metadata particularly includes report's title, date, authors, owners, and so on.
- SSUFI is one of many methods for report outlining. SSUFI is the acronym for Summary, Stage-setting, Undertaking, Finding, Interpretation.
- The summary is the condensed presentation of the substance of the report content. It allows its reader to decide whether he or she is interested in further reading. The summary briefly answers the question, "What the report changes."
- The stage-setting section describes the problem, background, situation, and/or the tasks for which the project or research was undertaken. This section answers the questions, "Who, where, when, and why undertook the research."
- The undertaking section describes the actions, methods, assumptions, and procedures. This section answers the question, "How the research was undertaken."
- The finding describes the research results. This section answers the question, "What has been found."
- The interpretation describes conclusions, solutions, and implications that can be derived from the report findings, as well as discussions that, possibly, represent different opinions, and, if requested, recommendations for further courses of action. This section answers the question, "What people think the report changes."
- The STAR Layout is often used in job interviews. STAR stands for Situation, Task, Action, Result is. In comparison with SSUFI, it skips the summary and interpretations, as well as divides the stage-setting into situation and task. The summary can be skipped since the STAR-outlined report is usually given in response to interviewer's request.
- White papers can be defined as those technical reports that have been created to educate product customers. Because of their marketing purpose, these papers are usually written in simpler language than technical reports. White papers may also include opinion statements in any section; the technical reports tend to allow opinions only in the interpretation section.
Key terms
- Technical report, scientific report, report content, SSUFI, document summary, report stage-setting section, report undertaking section, report finding, report interpretation, STAR Layout (situation, task, action, result), white paper
Closing
- Fill in the blanks:
- __________ papers is a type of technical report that can be created to educate product customers.
The successor lectio is Tech Report Metadata.
