dev-workflow
开发流程五步法
需求理解 → 方案设计 → 代码实现 → 代码审查 → Bug 修复
使用时机
- 用户描述新功能/项目想法,需要需求分析
- 用户提到「方案设计」「架构设计」「怎么实现」
- 用户提到「代码实现」「开始写代码」「帮我实现」
- 用户提到「代码审查」「Review」「检查代码」「看看有没有问题」
- 用户提到「bug」「报错」「崩溃」「异常」「不工作」「出错了」「测试失败」
Step 1:识别当前步骤
根据用户需求选择对应 reference 文件执行:
| 步骤 | 文件 | 触发关键词 |
|---|---|---|
| 需求理解 | requirement.md | 需求分析、理解需求、整理需求、帮我梳理 |
| 方案设计 | design.md | 方案设计、技术设计、架构设计、怎么实现 |
| 代码实现 | implementation.md | 代码实现、开始写代码、帮我实现、写一下 |
| 代码审查 | review.md | 代码审查、Review、检查代码、看看有没有问题 |
| Bug 修复 | bug-fix.md | bug、报错、崩溃、异常、不工作、出错了、测试失败 |
Step 2:收集输入
- 需求理解:从用户描述或对话中提取功能想法、约束条件
- 方案设计:确认已有需求文档,或简要收集关键信息
- 代码实现:确认已有技术方案,或根据需求快速拟定实现思路
- 代码审查:明确审查范围(哪些文件/模块)
- Bug 修复:确认错误信息、复现步骤、环境信息
Step 3:执行、输出与自动落盘
读取对应 reference 中的完整流程,按步骤执行,输出符合该阶段要求的交付物。
其中以下步骤必须自动写入文档:
- 需求理解:
- 单模块/未指定模块:将最终需求文档追加写入当前工作目录的
docs/需求理解.md - 多模块且已识别模块名:将最终需求文档追加写入
docs/<module>/需求理解.md
- 单模块/未指定模块:将最终需求文档追加写入当前工作目录的
- 方案设计:
- 单模块/未指定模块:将最终方案文档追加写入当前工作目录的
docs/方案设计.md - 多模块且已识别模块名:将最终方案文档追加写入
docs/<module>/方案设计.md
- 单模块/未指定模块:将最终方案文档追加写入当前工作目录的
- 代码审查:
- 单模块/未指定模块:将最终审查报告追加写入当前工作目录的
docs/代码审查.md - 多模块且已识别模块名:将最终审查报告追加写入
docs/<module>/代码审查.md
- 单模块/未指定模块:将最终审查报告追加写入当前工作目录的
落盘规则:
- 默认目录为当前工作目录
docs/,若不存在则创建后再写入 - 多模块项目优先使用
docs/<module>/分目录;若无法确定模块则回退到docs/根目录 <module>使用稳定标识(建议用目录名/包名,避免同义词)- 文件不存在则创建,存在则追加,不覆盖历史内容
- 每次新增内容前写入时间标题:
## YYYY-MM-DD HH:mm - 标题后粘贴本次完整输出正文,末尾加分隔线
--- - 若用户明确指定了其他文件路径,优先按用户指定路径写入
- 可选维护
docs/模块索引.md记录模块名与文档路径映射,便于检索与归档
注意事项
-
流程串联:需求理解 → 方案设计 → 代码实现 → 代码审查 → Bug 修复;每步完成后提示用户进入下一阶段
-
上游缺失时:提示用户先完成前置步骤,或简要收集关键信息后继续
-
需求理解、方案设计与代码审查阶段默认必须自动落盘(追加写入),不要覆盖历史记录
More from xstongxue/best-skills
wechat-article-writer
公众号/自媒体全流程。根据用户表述自动匹配:撰写文章、封面图、正文插图、风格提取。支持多种写作风格。当用户提到写公众号、技术博客、公众号封面、正文插图、步骤图、演示图、流程示意、分析写作风格、克隆文风、模仿爆款、提取风格时使用。详见 reference 目录。
176drawio-diagram
为深度学习模型、网络架构、算法流程等生成标准 Draw.io (.drawio) 格式的可视化图表;支持从零生成与风格迁移两种模式。从零生成:模型架构图、流程图、感受野示意图等;风格迁移:参考图 + 内容描述/项目 → 按参考图风格生成新图。确保 XML 格式正确,可直接在 Draw.io 中打开编辑。
81paper-write
本科与硕士学位论文全流程撰写辅助。支持大纲审核(理工科/文科)、结构仿写(通用/实验/绪论/摘要;文科含文献综述、案例分析、对策建议、文科绪论与摘要)、参考文献获取、融合、润色(含实验章节/文科章节)、缩写、扩写、防 AIGC、中英互译、结构化信息提取。当用户提到论文撰写、大纲审核、论文章节仿写、参考文献、论文润色、防 AIGC、论文翻译、文科论文、文献综述、对策建议时使用。
77codegen-diagram
基于当前项目/代码生成 Draw.io 图表,支持技术栈图、系统架构图、数据结构图、E-R 图四种类型。输出符合 Draw.io 语法的 .drawio 文件(mxGraph XML),可直接导入 Draw.io 编辑。当用户提到技术栈、系统架构、数据结构、E-R 图时使用。
70md-report-summary
生成高质量 Markdown 周报、工作汇报、总结、介绍等文档。无草稿时从 Web 搜索并总结;有草稿时结合草稿整理、润色、补充。当用户提到周报、工作汇报、总结、介绍、述职、复盘时使用。
70pptgen-drawio
根据论文或汇报内容生成多页 Draw.io 格式 PPT,支持论文答辩与通用汇报两种模式,自动导出为 .pptx。当用户提到论文答辩 PPT、答辩幻灯片、通用 PPT、汇报 PPT、根据模板生成 PPT、drawio2pptx 时使用。
62