关于 dev-workflow
dev-workflow 是面向软件开发任务的 Agent Skill,按需求理解、方案设计、代码实现、代码审查和 Bug 修复五个阶段指导工作。它根据用户表述选择对应流程,并规定文档的保存与更新方式。
主要功能
- 01识别开发流程阶段
- 02按阶段读取参考流程
- 03生成阶段交付物
- 04按规则保存和更新文档
- 05提示后续阶段及前置步骤
适用场景
- 01梳理需求并保存需求文档
- 02设计方案并维护设计记录
- 03检查代码或处理测试失败
- 04按阶段推进开发任务
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ xstongxue/ best-skills --skill dev-workflow安装后在 Claude Code 中输入/dev-workflow确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
reference/bug-fix.mddesign.mdimplementation.mdrequirement.mdreview.mdreference/review-kit/guides/architecture-review-guide.mdc.mdcommon-bugs-checklist.mdcpp.mdcss-less-sass.mdgo.mdjava.mdperformance-review-guide.mdpython.mdqt.mdreact.mdrust.mdsecurity-review-guide.mdtypescript.mdvue.mdreference/review-kit/templates/pr-review-template.mdreview-checklist.md详细介绍
来自项目 README开发流程五步法
需求理解 → 方案设计 → 代码实现 → 代码审查 → Bug 修复
Step 1:识别当前步骤
根据用户需求选择对应 reference 文件执行:
| 步骤 | 文件 | 触发关键词 |
|---|---|---|
| 需求理解 | requirement.md | 需求分析、理解需求、整理需求、帮我梳理 |
| 方案设计 | design.md | 方案设计、技术设计、架构设计、怎么实现 |
| 代码实现 | implementation.md | 代码实现、开始写代码、帮我实现、写一下 |
| 代码审查 | review.md | 代码审查、Review、检查代码、看看有没有问题 |
| Bug 修复 | bug-fix.md | bug、报错、崩溃、异常、不工作、出错了、测试失败 |
Step 2:执行、输出与落盘
读取对应 reference 中的完整流程,按步骤执行,输出符合该阶段要求的交付物。
自动落盘(默认必须写入):
- 需求理解:
docs/<feature>/01-需求理解.md - 方案设计:
docs/<feature>/02-方案设计.md
可选落盘(默认不写,仅当用户明确要求时才写入):
- 代码审查:
docs/<feature>/03-代码审查.md - Bug 修复:
docs/<feature>/04-bug修复.md
落盘规则:
- 目录为当前工作目录
docs/下,不存在则创建 - 按功能划分子目录:能识别出功能(如登录、测试、部署等)就必须写入
docs/<feature>/,即使只有一个功能也不写入根目录;涉及多个功能时各建子目录,同一功能的全部文档归入同一子目录 - 无法识别功能或跨功能全局性内容(如整体架构设计):写入
docs/通用/ <feature>使用稳定标识(建议用功能英文名或代码目录名/包名,如login、deploy,避免同义词混用)- 演进式更新(不追加):主文件永远是最新完整版,结构为
# 文档标题→## 修订记录(表格:版本 | 日期 | 摘要)→ 本次完整正文 - 首次写入:创建文件,修订记录写入
v1 | YYYY-MM-DD HH:mm | 初版 - 再次写入:先将旧文件整体移入
docs/<feature>/archive/<原文件名>-v<N>-<YYYYMMDD>.md(同日多次归档加时分后缀),再重写主文件,修订记录表新增一行(版本号递增,摘要为一句话变更概括) - 若用户明确指定了其他文件路径,优先按用户指定路径写入
- 可选维护
docs/功能索引.md记录功能名与文档路径映射
注意事项
- 每步完成后提示用户进入下一阶段
- 上游缺失时:提示用户先完成前置步骤,或简要收集关键信息后继续
评论
支持 Markdown