Technical Report Pro

Degrees of Freedom

• MEDIUM is the right setting because structure is fixed by templates while content and evidence stay user-driven.
• Allow customization of title, output path, author, and scan scope.
• Preserve section headings in generated reports for consistency and comparability.

Progressive Disclosure

Level 1 - Quick Generation

Use one command to generate the required report type.

python3 scripts/report_gen.py --type arch-review --title "Gateway Architecture Review"
python3 scripts/report_gen.py --type post-mortem --title "Database Outage 2026-02-14"
python3 scripts/report_gen.py --type research-summary --title "Skill Trigger Precision Analysis"
python3 scripts/report_gen.py --type debug-investigation --title "OAuth Token Refresh Failure"

Level 2 - Customization

Control output location and enrich draft context from local files.

python3 scripts/report_gen.py \
  --type debug-investigation \
  --title "OpenAPI Parser Crash" \
  --author "Archie" \
  --scan ./dev/openapi-integrator \
  --keywords traceback parser schema \
  --max-files 30 \
  --output ./research/2026-02-14/DBG-openapi-parser-crash.md

Template customization rules:

• Keep canonical headings from assets/templates/ unchanged.
• Replace placeholder tables/checklists with concrete project data.
• Use --output for date-stamped or queue-specific report destinations.

Level 3 - Evidence and Quality

Enforce evidence-first writing and stronger review bars.

• Apply claim -> evidence -> impact -> action in each major section.
• For incident/debug reports, capture exact command snippets and key outputs.
• For architecture/research reports, include explicit trade-offs and confidence level.
• Use references/guides/evidence-first-reporting.md and assets/evidence-section-guide.md as pre-review checks.

Recommended --scan enrichment patterns:

• --scan . --keywords error exception timeout failed
• --scan ./research --keywords metric benchmark latency
• --scan ./dev/<project> --keywords stack trace root cause fix

Template Structure

• Architecture Review template: overview -> architecture -> justification -> verification -> recommendations.
• Post-Mortem template: timeline -> root cause -> response -> resolution -> action items.
• Debug Investigation template: problem statement -> investigation -> root cause -> solution -> verification.
• Research Summary template: question -> methodology -> findings -> insights -> recommendations.

All templates live in assets/templates/ and are selected via --type.

Templates and Examples

• Templates: assets/templates/
• Examples: references/examples/
• Guides: references/guides/

Quality Bar

• Keep executive summary concise.
• Separate why/how/evidence clearly.
• Ensure each technical claim has supporting proof.