Files
OpenFlare/.agents/skills/plan/SKILL.md
T
2026-08-04 11:40:32 +08:00

2.4 KiB
Raw Blame History

name, description
name description
plan 项目级技能:规定在开启新方案、新计划或进行任务交接时,必须将计划落库到 docs/plan 文件夹中并使用对应模板。

Plan & Handover Skill

当你在当前项目中被要求“开启一个新的方案”、“制定开发计划”或者准备“任务交接(Handover)”时,你必须遵循本技能的工作流,将计划或方案落库到 docs/plan/ 目录下。

Important

什么时候应当创建实现计划?

  • 必须创建的场景:新功能开发、涉及多组件的重大架构重构、引入新基础设施依赖,以及存在显著设计决策冲突的中大型、复杂需求。
  • 绝对不要创建的场景:改个包名、挪个文件、重命名函数、小修小改修复 Bug 等轻量级、简单的局部重构。对于此类改动,应当直接完成并运行单元测试通过后交付,禁止制造冗余的计划文档。

执行工作流 (Workflow)

1. 确定计划类型

  • 新特性/技术实现计划:如果你要开发新功能或进行重大重构,你需要创建实现计划。
  • AI 任务交接计划:如果当前任务尚未完成但需要记录进度留作以后或其他 AI 代理接手,你需要创建交接计划。

2. 读取对应模板

在创建计划文档前,必须读取对应的模板内容,并严格按照模板的骨架进行填充:

  • 实现计划模板:docs/plan/implementation-plan-template.md
  • 接手计划模板:docs/plan/handover-plan-template.md

3. 落库与命名规范

在 docs/plan/ 目录下创建新的 Markdown 文件进行保存:

  • 实现计划命名格式:docs/plan/YYYYMMDD-[feature-name].md (例如:20260605-uptime-kuma-sync.md)
  • 接手计划命名格式:docs/plan/handover-[task-name].md (例如:handover-waf-ip-group.md)

4. 隔离约束 (极其重要)

docs/plan/ 目录下的文档仅限内部开发和 AI 代理同步使用。

  • 绝对禁止将新创建的 plan 文档加入到项目的官方导航配置(如 docs/config.ts 的 nav 或 sidebar 导航条中)。
  • 绝对禁止通过任何方式将其暴露给文档渲染框架(如 VitePress)对外渲染。

后续动作

落库完成后,向用户报告计划已生成在 docs/plan/ 目录下,并列出文档的核心要点或待决策项(如有),等待用户 Review 或批准后即可推进下一步。