Technical Finding Documentation
What you'll learn: How to write clear, reproducible technical documentation for security vulnerabilities discovered during penetration testing.
Why Technical Documentation Matters
When you discover a vulnerability, your job isn't done—you must document it so developers can understand, reproduce, and fix it. Think of it like a recipe: if you skip steps or ingredients, the chef can't recreate the dish. Poor documentation wastes everyone's time and delays remediation.
Essential Components of a Technical Finding
Every vulnerability report should include:
1. Detailed Description
Explain what the vulnerability is in technical terms. Reference the vulnerability type (e.g., "SQL Injection in login form") and describe the underlying security flaw.
2. Affected Systems
List specific systems, applications, URLs, IP addresses, or components impacted. Be precise—"web server" is too vague; "webshop.example.com:443 /api/users endpoint" is actionable.
3. Reproduction Steps
Provide a numbered, step-by-step guide that anyone with appropriate access can follow:
- Navigate to login page
- Enter
admin' OR '1'='1in username field - Enter any password
- Click Login button
- Observe unauthorized access granted
4. Evidence
Include screenshots, logs, HTTP requests/responses, or command output proving the vulnerability exists. Redact sensitive data but preserve enough detail to demonstrate impact.
5. Technical Impact
Explain what an attacker could achieve (data theft, privilege escalation, system compromise). Connect this to the severity rating you assigned earlier.
Writing for Your Audience
Technical findings target developers and security engineers. Use precise terminology, avoid ambiguity, and provide enough detail that someone unfamiliar with your testing can reproduce the issue independently.
Key Takeaway: Effective technical documentation requires detailed descriptions, precise affected system identification, clear reproduction steps, solid evidence, and impact analysis—ensuring vulnerabilities can be understood, verified, and fixed efficiently.