Skip to content

Documentation & Reporting ​

FieldValue
Module ID162
DifficultyEasy
TierTier II
CategoryGeneral
Estimated Time2 days
Cubes Earned20
Experience Points450
Creatorsc0rndogs, mrb3n
Last Updated2022-06-24T00:00:00.000000Z
URLhttps://academy.hackthebox.com/app/module/162

Module Includes ​

  • 8 Sections
  • 3 Interactive Exercises
  • 0 Assessments
  • 20 Cubes

Module Description ​

Proper documentation is paramount during any engagement. The end goal of a technical assessment is the report deliverable which will often be presented to a broad audience within the target organization. We must take detailed notes and be very organized in our documentation, which will help us in the event of an incident during the assessment. This will also help ensure that our reports contain enough detail to illustrate the impact of our findings properly.

Module Summary ​

This module covers documentation and reporting, which are essential "soft skills" for an information security professional, but imperative for penetration testers. Without proper documentation and reporting, we would not be able to clearly convey findings to our client, provide sufficient evidence for technical staff to recreate issues, or give actionable remediation recommendations. Detailed documentation not only helps when it comes time to write the report (which is the key deliverable for any penetration test or technical security assessment) but also helps in case a client has a question and seeks further evidence or is looking to correlate a network issue with testing activities.

In this module, we will cover:

  • Organizing our notetaking tool of choice for success
  • Various types of reports we may be asked to produce for a client
  • The components of a penetration test report
  • How to write up a finding in detail
  • When to use vulnerability notifications and how to write one
  • Various tips and tricks to help streamline reporting

CREST CPSA/CRT-related Sections:

  • All sections

CREST CCT APP-related Sections:

  • All sections

CREST CCT INF-related Sections:

  • All sections

This module is broken down into sections with accompanying examples for each topic we cover.

As you work through the module, we recommend you follow along with the sample report template attached under Resources in the top right of any section. It is worth setting up your own documentation/notetaking system and practicing writing up a sample report using one or more modules as practice.

You can start and stop the module at any time and pick up where you left off. There is no time limit or "grading," but you must complete all of the exercises and the skills assessment to receive the maximum number of cubes and have this module marked as complete in any paths you have chosen.

The module is classified as "Easy" and assumes a working knowledge of information security and the penetration testing process.

A firm grasp of the following module can be considered a prerequisite for successful completion of this module:

  • Penetration Testing Process

This module is a required (and essential) module in the Penetration Tester path.

Sections ​

8 sections - 3 Interactive

#GroupTypeTitle
1IntrotheoryIntroduction to Documentation & Reporting
2PreparationinteractiveNotetaking & Organization
3theoryTypes of Reports
4theoryComponents of a Report
5ReportinginteractiveHow to Write Up a Finding
6theoryReporting Tips and Tricks
7Next StepsinteractiveDocumentation & Reporting Practice Lab
8theoryBeyond this Module - Documentation & Reporting

Conclusion ​

This module covered setting ourselves up for success with proper documentation, various types of a report, and how to write all components of a report

Module Key Takeaways

  • Organization and notetaking
  • Types of reports
  • Components of a report
  • Steps for writing up a finding
  • When/where to use vulnerability notification reports
  • Additional tips and tricks to set us up for success