compose:report

Consolidates spec iterations into a final-state feature report and marks related specs.

Updated Jun 27, 2026
One-click install
npx skills add https://github.com/HKUST-QUANT-SOCIETY/quantcode --skill compose-report-hkust-quant-society
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: compose:report
Source: https://github.com/HKUST-QUANT-SOCIETY/quantcode/tree/main/.opencode/meta-skills/report
Command: npx skills add https://github.com/HKUST-QUANT-SOCIETY/quantcode --skill compose-report-hkust-quant-society

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After a feature is implemented across multiple spec and plan iterations, documentation becomes fragmented and outdated. This Skill consolidates the entire spec history into a single self-contained final report describing what was actually built, so readers no longer need to dig through superseded design documents. ## Core Features & Use Cases - Final-State Report Generation: Produces a structured Markdown report (What Was Built, Architecture, Usage, Verification, Journey Log) derived from the implemented code rather than the specs. - Spec and Plan Marking: Prepends an idempotent NOTE admonition to each related spec and plan file pointing readers to the final report, without moving or deleting anything. - Workflow Integration: Runs after verification and hands off to the merge step, with frontmatter listing specs, plans, branch, and commit range for tooling. - Use Case: After shipping a multi-iteration feature, invoke this Skill to write reports/<feature-name>.md, mark all related specs as superseded, and commit everything before merging the branch. ## Quick Start Ask the assistant to use the report skill to write the final report for the feature just implemented and verified.

Frequently Asked Questions about compose:report

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a final report after implementing a feature?

Invoke the report skill after implementation is verified. It reads the shipped code, drafts What Was Built, Architecture, Usage, and Verification sections, appends a brief Journey Log, saves the report to the reports directory, and marks related specs.

What is the difference between a spec and a final report?

Specs are accumulative design documents created per iteration, while the final report is a single overwritten file describing the delivered state. The report is derived from code, not specs, and is self-contained so readers need no spec files.

When should I skip writing a final report?

Skip the report when the user explicitly asks to skip it or when the change is trivially small, such as a single bug fix, typo, or config tweak that is not worth documenting.

Does the report skill delete or move old spec files?

No. The skill is non-destructive: it inserts a GitHub-compatible NOTE admonition between each spec's title and body pointing to the final report. Files stay in place so git history and existing links remain intact.

What happens if a report already exists for the feature?

The existing report is read first and then overwritten in place with updated content. New Journey Log entries are appended, and the specs and plans lists in the frontmatter are updated to include new iterations.