implementation-report
Skill3 starsChanged 52 days agoMITView on GitHub
需求完成后生成实现总结报告(最终实现效果、关联提交、偏差记录),与需求摘要一一对应。触发:"生成实现报告"、"记录一下完成情况";需求状态变为"已完成"时自动触发。
1 other project uses a version of this.
Adopted by
Most recently taken up by
- 20030419zhanghongyi/AI-Software-Engineering-Workflow-Templatetheir own version, first seen May 25, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 1
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository67 other files it gives its agents.
- acceptance-verifySkill
- api-designSkill
- api-testingSkill
- artifact-optimizerSkill
- auto-reviewSkill
- backend-indexSkill
- browser-evidenceSkill
- challengerSkill
- code-change-impactSkill
- code-implementSkill
- code-reviewSkill
- code-surveySkill
- content-simplifierSkill
- create-rulesSkill
- create-skillSkill
- create-sub-agentSkill
- data-flow-modelSkill
- debugSkill
- delivery-slicingSkill
- demo-verifySkill
- dependency-docsSkill
- design-craftSkill
- design-reviewSkill
- design-to-codeSkill
- document-writerSkill
- e2e-testingSkill
- ecosystem-reviewSkill
- expert-auditSkill
- expert-lookupSkill
- expert-solution-workflowSkill
- expert-teamSkill
- frontend-api-guideSkill
- frontend-indexSkill
- frontend-walkthroughSkill
- gitnexus-indexSkill
- harness-reviewSkill
- index-lookupSkill
- integration-mergeSkill
- interaction-designSkill
- ki-memory-lookupSkill
- ki-memory-writeSkill
- ki-search-firstSkill
- loop-discoverySkill
- memory-creatorSkill
- migrate-to-codehubSkill
- module-teachSkill
- negative-requirementSkill
- performance-analysisSkill
- plan-trackSkill
- product-managerSkill
- request-guardSkill
- requirement-doc-storeSkill
- requirement-miningSkill
- review-panelSkill
- scenario-rehearsalSkill
- strategiesSkill
- skill-amplifierSkill
- solution-captureSkill
- solution-lookupSkill
- strong-relationSkill
- The first 60 shown.
The file
Files
Implementation Report(实现报告)
需求开发完成后,自动归档实现结果,形成完整的需求→设计→实现→验收链路。
定位
design-craft → 开发实现 → implementation-report
技术设计 编码提交 归档实现结果- 输入:需求 ID、git 提交记录、实际实现情况
- 输出:实现报告文档 + meta.json 状态更新
- 边界:只记录"实现了什么",不管"怎么实现"(设计文档负责)
核心原则
- 事实导向:只记录实际发生的事情,不写计划或期望
- 偏差必录:实现与设计不一致的地方必须记录,不隐瞒
- 可追溯:每个提交、每个偏差都有对应的设计文档章节引用
- 自动化优先:尽可能从 git 历史和需求元数据自动提取信息
工作流总览
阶段 1:收集实现数据 → 从 git 历史和需求元数据提取信息
阶段 2:偏差分析 → 对比设计与实现,记录偏差
阶段 3:生成报告 → 输出结构化实现报告
阶段 4:需求管理集成 → 更新 meta.json 状态和文档关联阶段 1:收集实现数据
从多个来源自动提取实现信息。
数据来源
| 来源 | 提取内容 | 提取方式 |
| meta.json | 需求元数据(feature、tags、depends_on) | req list --id {REQ-NNN} |
| git 历史 | 关联提交的变更内容 | git log --oneline {commit_hash} |
| 设计文档 | 设计方案(用于偏差对比) | 读取需求目录下的 design/ 文档 |
| 代码文件 | 实际实现 | 读取相关代码文件 |
输出格式
📋 实现数据收集
需求信息:
ID: REQ-NNN
功能: {功能名称}
状态: 实施中
关联提交: {commit1}, {commit2}
设计文档:
- design/DESIGN.md(主设计)
- design/S01_子需求_DESIGN.md
请确认数据是否完整,有无遗漏的提交或文档。阶段 2:偏差分析
对比设计文档与实际实现,记录偏差。
偏差类型
| 偏差类型 | 说明 | 严重度 |
| 方案偏差 | 实现方案与设计不一致 | 高 |
| 范围偏差 | 实现范围超出或小于设计范围 | 中 |
| 接口偏差 | 接口签名与设计不一致 | 高 |
| 数据偏差 | 数据模型与设计不一致 | 高 |
| 遗漏 | 设计中有但未实现 | 中 |
| 额外实现 | 设计中无但实际实现了 | 低 |
输出格式
🔍 偏差分析
| 编号 | 偏差类型 | 设计描述 | 实际实现 | 严重度 | 原因 |
|------|----------|----------|----------|--------|------|
| D-01 | 方案偏差 | ... | ... | 高 | ... |
| D-02 | 额外实现 | — | ... | 低 | ... |
若无偏差,输出:✅ 实现与设计一致,无偏差。阶段 3:生成报告
将收集的数据和偏差分析合并为结构化报告。
报告模板
---
id: {REQ-NNN}
feature: {功能名称}
status: 已完成
created: {YYYY-MM-DD HH:mm:ss}
updated: {YYYY-MM-DD HH:mm:ss}
version: {N}
tags: [{标签}]
depends_on: [{依赖}]
author: AI
document_type: report
---
# 实现报告:{功能名称}
## 实现摘要
{一句话概述最终实现效果}
## 关联提交
| 提交 Hash | 提交信息 | 关联子需求 |
|-----------|----------|-----------|
| {hash} | {message} | {S-XX} |
## 偏差记录
| 编号 | 偏差类型 | 设计描述 | 实际实现 | 原因 |
|------|----------|----------|----------|------|
| ... | ... | ... | ... | ... |
(若无偏差,写"实现与设计一致,无偏差")
## 验收结果
- [ ] 功能验证通过
- [ ] 性能指标达标
- [ ] 异常路径覆盖阶段 4:需求管理集成
自动触发条件
项目中存在 .requirements/config 且 storage_path 指向有效目录。
集成步骤
- 写入实现报告到需求目录后,调用
req update注册文档关联并更新状态:
req update {REQ-NNN} \
--docs add report.md,report --status 已完成 --changelog "实现报告归档"- 追加关联提交(如果 meta.json 中尚未记录):
req update {REQ-NNN} \
--commit {git_hash}- 错误处理:
- 需求 ID 不存在 → 提示用户先创建需求,跳过集成
- 文件锁超时 → 自动重试 1 次,仍失败则告知用户
- 状态校验失败 → 提示具体错误,不自动修复
存储路径映射
| 产出物 | 存储路径 | docs 类型 |
| 实现报告 | report.md | report |
反模式
- ❌ 报告只写"已完成"无具体内容 → 必须记录实际实现效果
- ❌ 隐瞒偏差 → 偏差必须如实记录
- ❌ 忘记更新 meta.json 状态 → 必须同步更新为"已完成"
- ❌ 忘记追加 commit → 关联提交必须写入 meta.json
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

