SuperAPI AI 工具集

maintain-project-roadmap

办公与效率

查看项目

更新于 10-16 06:55

技能介绍

用途

Maintain Project Roadmap 用于维护项目中的清单式(checklist-style)ROADMAP.md 文件。它通过一个确定性的路线图工作流,对路线图进行审计、创建、迁移或规范化,适用于需要检查或整理项目路线图的场景。

主要能力

该技能以清单式 ROADMAP.md 作为规范格式,提供两种运行模式:

  • check-only:审计章节、复选框、里程碑顺序以及旧格式。
  • apply:创建、迁移或规范化目标 ROADMAP.md。

在 apply 之后,会重新运行相同的检查,以确认剩余的发现项。

使用方式

输入参数:

  • 必需:--project-root <path>
  • 必需:--run-mode <check-only|apply>
  • 可选:--roadmap-path <path>
  • 可选:--config <path>

工作流步骤:

  1. 校验项目根目录。
  2. 解析路线图路径。
  3. 在 check-only 模式下,审计章节、复选框、里程碑顺序和旧格式。
  4. 在 apply 模式下,创建、迁移或规范化目标 ROADMAP.md。
  5. 重新运行相同的检查,以确认剩余的发现项。
  6. 返回 Markdown 以及 JSON 路线图报告。

输出契约

返回 Markdown 加 JSON,包含:

  • run_context
  • findings
  • apply_actions
  • errors

如果没有发现项、没有应用操作且没有错误,则精确输出 No findings。

适用场景

当项目路线图需要审计、创建、迁移或规范化时使用。尤其适合需要以确定性方式维护清单式 ROADMAP.md 的项目。

限制与护栏

  • 绝不自动提交、自动推送或打开 PR。
  • 在 apply 模式下,绝不编辑目标 ROADMAP.md 以外的文件。
  • 保持清单式 ROADMAP.md 作为规范格式。

参考资料

  • references/roadmap-automation-prompts.md
  • references/roadmap-customization.md
  • references/roadmap-config-schema.md