Narrative
The project narrative is a markdown document that captures the assessment methodology, progress, and overall findings story. It serves as the qualitative counterpart to the findings tracked in the Issues tab.
Screenshots use fictional demonstration data.
Writing the Narrative
The narrative editor supports full markdown: headings, lists, tables, code blocks, inline images, and links.
A typical narrative covers:
- Executive summary: high-level overview for non-technical stakeholders
- Methodology: approach taken during the engagement (tools, testing phases, coverage)
- Findings overview: summary of discoveries organized by impact or category
- Recommendations: strategic guidance beyond individual vulnerability fixes
Access Control
| Role | Access |
|---|---|
| Providers / Pentesters | Read and write |
| Clients | Read-only |
Clients can review the assessment documentation without modifying the provider's work.
Narrative in Reports
The narrative content is included in generated PDF reports. When a report is generated, narrative sections are pulled into the executive summary, methodology, and overall assessment description.
TIP
Write your narrative with the final report in mind. Content here flows directly into the deliverable, so use professional language and structure it for your audience.