Skip to content

A complete, production-ready reporting system used by 7BlockLabs for smart contract audits, protocol reviews, and dApp security assessments. Includes the full Problem → Findings → Fixes → Impact methodology, Markdown report templates, finding schemas, severity rubrics, examples, style guides, and publishing instructions.

Notifications You must be signed in to change notification settings

7BlockLabs/audit-report-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

7BlockLabs – Security Audit / Report Template Pack

This pack gives you a complete, production-ready template to deliver audits and verification reports.

Contents

  • templates/security-audit-report_template.md – master report template (Markdown).
  • templates/finding_template.md – per-finding write-up template.
  • templates/findings_schema.yaml – YAML schema for findings.
  • templates/sample_findings.yaml – small example file.
  • docs/STYLE_GUIDE.md – voice, formatting, severity rubric, and screenshot rules.
  • scripts/publish.md – how to publish (GitHub, Google Docs, GitHub Pages, PDF).

Workflow (Problem → Findings → Fixes → Impact)

  1. Problem – summarize business/context risk and scope.
  2. Findings – enumerate issues with evidence and risk ratings.
  3. Fixes – recommend and verify remediations.
  4. Impact – quantify risk reduction and next steps.

Versioning

  • Tag releases as report-vYYYY.MM.DD when sending to clients.
  • Keep CHANGELOG section inside the report and update at every revision.

About

A complete, production-ready reporting system used by 7BlockLabs for smart contract audits, protocol reviews, and dApp security assessments. Includes the full Problem → Findings → Fixes → Impact methodology, Markdown report templates, finding schemas, severity rubrics, examples, style guides, and publishing instructions.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published