A technical report conveys information about an issue, product, or event. Even though the document usually targets one group of readers, it should have value to a wide ranging audience: management, technical colleagues, and interested third parties such as customers or investors. The sections of a technical report vary, but in general, readers expect an: abstract, executive summary, introduction, body, conclusion and when needed supporting technical documentation.
Abstract: This is your contract with your reader. It should be very concise and simply tell them what the document is about so they can decide it they wish to read it. This is different than an executive summary which tells the reader what they need to know. Try to target 100 - 200 words.
Executive Summary: Even though this is part of the technical report, consider printing separate one page copies of the executive summary, or paginating the technical report, so that busy senior executive can simply refer to this part of the report to learn what the authors and reviewers feel they need to know. Make sure you are clear on actionable recommendation. For more specific guidance on the executive summary please see:
https://securitywa.blogspot.com/2017/11/tips-for-success-writing-executive.html
Introduction: This part of the technical paper establishes the structure of the information you wish to share. Ideas, concepts, or issues brought up in the introduction should be aligned with the executive summary and fully explored, or explained in the body of the paper. NOTE: assertions in the introduction should be supported, either immediately by citations, (SANS and GIAC require APA), or by the results of lab experiments referenced later in the technical report, or supporting technical documentation.
Body: The body of the technical report supports the executive summary and must be written to be useful to both management and technical colleagues. Cybersecurity reports commonly describe the issue at hand, risks, and expand on immediate, medium term, and long term recommendations that are briefly mentioned in the executive summary. NOTE: avoid the trap of explaining basic material. There is a tutorial for almost every 101 level topic. Simply reference the best tutorial on any subject your paper covers and move on to explain new, applicable, actionable, information.
In general the body is one of the largest sections of the document. Consider the use of white space, headings, subheadings, bulleted or numbered lists, tables and possibly color to help make the meaning of the information clear. If you see a single paragraph that is a half a page or longer that is a sign the body needs organizational work.
Conclusion or summary: The secret to great written and oral communication is to tell your audience what you are going to tell them, tell them about the issue with supportable detail, and then tell them you have told them. A good way to write a conclusion is to take the introduction, verify that you have covered all of its points and then summarize what you have shared. After you have written the conclusion, take the time to compare it to the executive summary to ensure that you have fully explained the information you wish to share with a C-level executive.
NOTE: it may be appropriate to mention opportunities for further research, or development, in the conclusion.
Additional technical information, lab notebooks, technical appendices: This is the part of the technical report targeted squarely at subject matter experts in the topic area. Screen shots, packet traces, output of tools and so forth are difficult to read. Place them at the end of the document, arrange them so that readers can see how the information supports your assertions, or duplicate your work. For additional guidance on a lab notebook, please see:
https://securitywa.blogspot.com/2017/11/sansedu-ise-6100-assignment-lab.html
Version 1.0 1/4/2018
Version 1.1 1/6/2018 Executive summary: make sure it is actionable. Body: move past the basics, avoid large blocks of text with no white space.
C Math Programming
ReplyDelete