implementation-report

Generates implementation summary reports from git history and requirement metadata.

2|Updated Jun 8, 2026
One-click install
npx skills add https://github.com/HACK-WU/skills --skill implementation-report-hack-wu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: implementation-report
Source: https://github.com/HACK-WU/skills/tree/main/skills/implementation-report
Command: npx skills add https://github.com/HACK-WU/skills --skill implementation-report-hack-wu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After a requirement is developed, teams often lack a structured record of what was actually implemented, which commits relate to it, and where the implementation deviated from the design. This Skill automates that archival step so the requirement-to-delivery chain stays traceable. ## Core Features & Use Cases - Automated Data Collection: Extracts requirement metadata via the req CLI, pulls related commits from git history, and reads design documents for comparison. - Deviation Analysis: Compares design documents against actual implementation and classifies deviations (scheme, scope, interface, data, omissions, extras) with severity levels. - Requirement Management Integration: Writes the report to the requirement directory and updates meta.json status to completed via req update, including commit association. - Use Case: After finishing development of REQ-003, ask the AI to generate the implementation report; it collects commits, records deviations from the design doc, writes report.md, and marks the requirement as completed. ## Quick Start Generate the implementation report for requirement REQ-003 based on its git commits and design documents.

Frequently Asked Questions about implementation-report

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

FAQPage Schema
How do I generate an implementation report for a completed requirement?

Provide the requirement ID and the Skill collects metadata via req list, extracts related commits from git history, compares against design documents, and writes a structured report.md. It then updates meta.json status to completed using req update.

What information goes into an implementation report?

The report contains an implementation summary, a table of related commits with hashes and linked sub-requirements, a deviation record comparing design versus actual implementation, and an acceptance checklist covering functionality, performance, and exception paths.

How does the deviation analysis work in implementation reporting?

Deviation analysis compares design documents against actual code and classifies differences into types: scheme, scope, interface, data deviations, omissions, and extra implementations. Each deviation gets a severity level and a recorded reason.

Does the implementation report integrate with requirement management tools?

Yes, when .requirements/config exists with a valid storage_path, the Skill registers the report via req update, sets the requirement status to completed, and appends related commit hashes to meta.json. Missing requirement IDs trigger a prompt to create the requirement first.

What are the limitations of automated implementation reporting?

The report only records what was implemented, not how or why design decisions were made, which remains the design document's role. It also depends on accurate git history and existing requirement metadata, so unlinked commits must be supplied manually.