Agent-design-language product-report-writer
Turn CodeBuddy review packet artifacts into customer-grade product reports with executive summary, scope, top findings, architecture summary, diagrams, test recommendations, remediation sequence, caveats, and residual risks while preserving severity, disagreement, and publication boundaries.
git clone https://github.com/danielbaustin/agent-design-language
T=$(mktemp -d) && git clone --depth=1 https://github.com/danielbaustin/agent-design-language "$T" && mkdir -p ~/.claude/skills && cp -r "$T/adl/tools/skills/product-report-writer" ~/.claude/skills/danielbaustin-agent-design-language-product-report-writer-e99da9 && rm -rf "$T"
adl/tools/skills/product-report-writer/SKILL.mdProduct Report Writer
Write a customer-grade CodeBuddy review report from already-produced review artifacts. This skill is a report-writing and packaging skill, not a reviewer, not a remediator, not a publisher, and not an approval authority.
Use this skill after review packet construction, specialist reviews, synthesis, diagram planning/review, test planning, redaction, and issue planning have produced the evidence needed for a report.
Quick Start
- Confirm the report source:
- CodeBuddy packet root
- synthesis artifact
- specialist artifact bundle
- existing draft report refresh
- Confirm audience, privacy mode, and publication intent.
- Run the deterministic helper when local filesystem access is available:
scripts/write_product_report.py <packet-root> --out <artifact-root>
- Review the report for evidence boundaries, severity preservation, specialist disagreement, and residual risk.
- Stop before publication, approval, customer delivery, issue creation, PR creation, remediation, or repository mutation.
Required Inputs
At minimum, gather:
orartifact_rootpacket_rootmodeaudiencepolicy
Supported modes:
write_from_packetwrite_from_synthesiswrite_from_specialist_artifactsrefresh_report
Useful policy fields:
privacy_modepublication_intentwrite_report_artifactrequire_redaction_statuspreserve_specialist_disagreementstop_before_publicationstop_before_mutation
If there is no concrete artifact root or report source, stop and report
not_run.
Workflow
1. Establish Report Boundary
Record:
- artifact root or source report
- repo name and ref, if present
- audience
- privacy mode
- publication intent
- redaction status
- specialist artifacts included
- non-reviewed surfaces
Do not upgrade publication readiness. If redaction or quality-gate evidence is missing, make that caveat prominent.
2. Preserve Review Truth
Carry forward:
- highest severity per finding
- source roles
- confidence
- evidence summary
- impact
- recommended action
- validation gap
- specialist disagreement
- residual risk
- non-reviewed surfaces
Do not rewrite findings into softer product language that hides severity, uncertainty, or disagreement.
3. Write The Report
The report should include:
- executive summary
- review scope
- top findings
- architecture summary
- security and privacy notes
- diagram links
- test recommendations
- documentation and onboarding notes
- remediation sequence
- caveats and residual risks
- appendix of source artifacts
Keep the report useful to a customer or leadership reader without losing enough evidence for an engineer to act.
4. Stop Before Publication
This skill must not:
- publish or send a report
- claim approval, compliance, merge-readiness, or remediation completion
- create issues, pull requests, tests, diagrams, ADRs, or fixes
- edit customer repositories
- run specialist review lanes
- hide missing redaction, quality-gate, or specialist coverage
Handoff candidates to:
before customer-facing useredaction-and-evidence-auditor
before publication candidate statusreview-quality-evaluator
for approved issue follow-throughfinding-to-issue-planner
for approved test planningreview-to-test-planner
ordiagram-author
when diagram evidence is missingrepo-diagram-planner
Output
Write Markdown and JSON report artifacts when an output root is available.
Default artifact root:
.adl/reviews/codebuddy/<run_id>/product-report/
Required artifacts:
codebuddy_product_report.mdcodebuddy_product_report.json
Use the detailed contract in
references/output-contract.md.
Blocked States
Return
not_run when the source is missing or unreadable.
Return
blocked when:
- publication was requested without redaction status
- the source has findings without evidence
- the requested report would hide severity or disagreement
- the report is asked to claim compliance, approval, merge-readiness, or remediation completion without proof
Return
partial when a report can be drafted but important specialist,
redaction, diagram, test, or quality-gate evidence is missing.