원클릭으로
doc-integrate
文档整合与同步维护 Skill。当用户说"整理文档"、"合并文档"、"更新开发文档"、"同步文档和代码"时触发。扫描散落文档,整合到 .dev_doc/ 对应模块的规范路径,验证文档与代码一致性,更新模块 README 和 CHANGELOG。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
메뉴
文档整合与同步维护 Skill。当用户说"整理文档"、"合并文档"、"更新开发文档"、"同步文档和代码"时触发。扫描散落文档,整合到 .dev_doc/ 对应模块的规范路径,验证文档与代码一致性,更新模块 README 和 CHANGELOG。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
Bug修复流程(代码定位→问题复现→问题修复→回归测试→提交完成)。触发:用户报告bug、报错、异常、或说"XX不工作"/"XX报错"/"XX有问题"/"修复XX"/"排查XX"/"XX挂了"/"XX崩了"/"修一下"/"debug"/"fix",通常会指出文件/函数/错误信息(KeyError/TypeError/OOM/ModuleNotFoundError/堆栈/控制台错误/白屏)或线上事故(内存泄漏/连接池耗尽/间歇性失败/重启后报错)。不要用于:新功能开发(用ez-dev)、配置调整、纯文档编写、"xxx怎么用"问答、纯阅读理解代码、对话式咨询。核心原则:worktree开发、测试复现优先、用户手动merge。
生成每日开发进度总结报告。并行执行进度总结、任务更新、全量测试、文档整理,汇总成HTML报告。
完整功能开发流程(需求→设计→计划→TDD开发→测试→完成)。触发:用户提出明确的开发任务时——"开发X"/"实现X"/"添加X功能"/"新功能"/"做个新特性"/"重构X"/"修复X bug"。不要用于:单行修改、配置调整、纯文档编写、"xxx怎么用"问答、bug 原因排查、纯阅读/理解代码、对话式咨询。核心原则:worktree开发、独立Subagent审查、用户手动merge。
通用测试工程技能。提供测试用例生成、测试执行、报告生成的完整流程指导。触发条件:用户提及"测试"、"编写测试"、"test"、"测试报告"、"生成测试用例"、"执行测试"、"测试覆盖"、"单元测试"、"集成测试"时触发。**仅用于独立的测试工程任务**(如专门编写一个测试套件、跑一轮全量测试、分析覆盖率);若是新功能开发流程中嵌套的测试编写由 `ez-dev` 触发;若是 bug 修复流程中的验证测试由 `bug_fix` 触发。
待办事项管理skilll。管理 todo.md 和 work_done.md为主的开发任务生命周期。当用户说"记录这个需求"、"帮我看看优先级"、"XX功能完成了"、"生成今日计划"、"看看今天该做什么"、"本周计划"、"本月计划"、"进度如何"时触发。也适用于:需要调整任务优先级、分析工作量、验证任务完成状态、整理待办事项。
"同步用户全局 skills 到 Git 仓库并发布。当用户说"同步skills"、"发布skills"、"更新skills到github"、"sync skills"时触发。**本 skill 只同步用户全局 skills(~/.claude/skills/),不同步项目内的 skills(项目 .claude/skills/ 目录)。**负责将全局 skills 同步到 dev_toolkits 仓库,并打包 .skill 文件发布 Release。"
| name | doc_integrate |
| description | 文档整合与同步维护 Skill。当用户说"整理文档"、"合并文档"、"更新开发文档"、"同步文档和代码"时触发。扫描散落文档,整合到 .dev_doc/ 对应模块的规范路径,验证文档与代码一致性,更新模块 README 和 CHANGELOG。 |
相关模块合并到统一路径。
vector-schema-sync + vector-store-async-query → vector_store/extra_function/utils/vector_stores → vector_store/相似功能整合到一个文档中,避免同一模块功能分散在多个 design.md。
已完成模块(Phase >= 6)的 design/plan/status 文档合并到模块 README。
模块/README.md 章节模块/CHANGELOG.md模块应在规范路径下,不在临时 feature 目录。
vector_store/ ✅vector-schema-sync/ ❌ 临时目录,应清空合并仍在开发的模块(Phase < 6)暂时不处理,等完成后再合并。
每个模块子目录下只保留两个文件:
README.md:记录模块架构、使用方法CHANGELOG.md:记录所有历史变更(包括已废除内容)其他内容全部整合到上述两个文件。
| 散落文档 | 归属 |
|---|---|
test_fix_plan.md | database/ |
excel-test-case-library-plan.md | database/ |
项目代码优化修改.md | 已完成→CHANGELOG,未完成→README |
text2sql_skill_suite_design.md | database/ |
.dev_doc/ 根目录的日期前缀文档(YYYY-MM-DD-*.md).dev_doc/<feature>/)必须扫描所有子目录,确保不遗漏任何文档。
对每份提到具体代码文件的文档:
每个子目录下只保留 README.md 和 CHANGELOG.md:
# 文档整合报告 - YYYY-MM-DD
## 整合统计
| 状态 | 数量 |
|------|------|
| 已整合到模块 README | X |
| 已删除 | X |
| 保留在根目录(可能需要开发) | X |
## 子目录清理
- ✅ vector_stores/:只保留 README.md, CHANGELOG.md
- ✅ database/:只保留 README.md, CHANGELOG.md
...
.dev_doc/
├── architecture.md ← 根目录核心文档
├── vector_stores/
│ ├── README.md ← 架构、使用方法
│ └── CHANGELOG.md ← 历史变更记录
├── data_process/
│ ├── README.md
│ └── CHANGELOG.md
└── <feature>/ ← ez-dev 临时目录,完成后清空
任何不在规范路径的文档都是待整理对象。
# 模块名
## 概述
一句话描述模块作用。
## 架构
模块整体结构和核心组件。
## 使用方法
### 初始化
```python
from module import ClassName
method_name(param)描述方法作用。
参数:
param (type): 参数描述返回: 返回值类型和含义
示例:
result = method_name("input")
相关配置项说明。
子模块作用和用法。
## 标准 CHANGELOG 格式
```markdown
# 模块名 CHANGELOG
## [未整合] YYYY-MM-DD
### 文档变更
- 合并 `原文档名` 到 README §章节名
- 删除 `原文档名`:原因
### 代码变动
- `文件路径`
- 变更描述
### 同步记录
- 文档与代码不一致处已修正:修正内容
关键结构:
| 区域 | 内容 |
|---|---|
| 概述 | 一句话,不超过两行 |
| 架构 | 组件关系,用文字或代码块描述 |
| 使用方法 | 按初始化→核心接口→配置→子模块顺序 |
| CHANGELOG | 每条变更带日期,包括已删除/废除记录 |