用途
Project Roadmap Manager 用于在项目根目录创建并维护 ROADMAP.md,将其作为项目里程碑与已接受计划的唯一事实来源(single source of truth)。它适合在以下场景使用:新项目初始化、计划接受或完成、里程碑或版本路线图设定与变更、里程碑达成/受阻/取消范围,以及路线图引用或查询。
主要能力
- 维护项目根目录下的 ROADMAP.md,优先更新已有章节而非追加重复内容。
- 保持 Current Milestone 与最新已接受计划同步。
- 将请求分类为事件类型并应用对应更新规则:项目初始化、计划接受/完成、里程碑/版本路线图设定或变更、里程碑达成/受阻/取消范围、路线图引用/查询。
- 保持各章节内部一致:Current Milestone 与 Milestones 中的活动里程碑匹配;Plan History 包含已接受计划快照;Change Log 记录每次路线图变更的日期与原因;启用子里程碑时,父子关联与 ID 唯一性有效。
- 支持通过配置文件进行定制,包括 milestoneIdStyle、targetStyle、statusValues、子里程碑启用/ID 风格/状态模型、负责人/依赖字段、计划历史与变更日志详细程度。
使用方式
- 加载活动定制配置:优先使用
<skill_root>/config/customization.yaml,回退到<skill_root>/config/customization.template.yaml,并将 settings 下的设置应用于路线图生成与更新决策。用户配置中缺失的子里程碑键按模板默认值处理。 - 识别项目根目录与目标文件:使用
<project_root>/ROADMAP.md;若根目录不明确,从仓库根目录推断。 - 确保 ROADMAP.md 存在:若缺失,使用本技能中的模板创建。
- 将请求分类为事件类型。
- 应用事件特定的更新规则。
- 保持所有章节内部一致。
ROADMAP.md 模板结构包括:# Project Roadmap、## Current Milestone、## Milestones、## Sub-Milestones(仅当 settings.enableSubMilestones 为 true 时包含)、## Plan History、## Change Log。
事件处理规则:
- 项目初始化:若 ROADMAP.md 不存在则创建;添加初始里程碑(除非用户提供不同标识符,否则为 M1);若 enableSubMilestones 为 true 且提供了初始子里程碑,则根据风格设置确定性地生成 ID;添加表示路线图初始化的变更日志条目。
- 计划接受或完成:更新 Current Milestone 以反映已接受计划;在 Milestones 中添加或更新对应行;若 enableSubMilestones 为 true,在活动里程碑下添加或更新受影响的子条目;在 Plan History 中追加包含范围与验收标准的 Accepted Plan 条目;添加变更日志条目,总结变更内容与原因。
- 里程碑或版本路线图设定/更新:若按 ID/版本存在则更新已有里程碑;仅当无匹配里程碑时才添加;避免同一 ID 或目标版本的重复里程碑;启用子里程碑时,避免同一父里程碑下重复子 ID,保持子状态值在 subMilestoneStatusValues 内(或子列表缺失时继承 statusValues),使用设置中的确定性 ID 生成规则(hierarchical:
<milestoneID><delimiter><n>,默认 M2.1;letter:<milestoneID><letter>,例如 M2a;ticket:<prefix><delimiter><zero-padded n>并带父上下文渲染,例如 M2-T01;external:仅当 allowExternalTrackerIds 为 true 时接受跟踪器 ID);若更新的里程碑为活动状态,同步 Current Milestone。 - 里程碑达成/变更:更新里程碑状态(Completed、In Progress、Blocked、De-scoped 或 Planned);若活动里程碑变更则更新 Current Milestone;启用子里程碑时保持子转换与父子关联一致;在 Change Log 中添加带日期的说明,记录转换与原因。
- 路线图引用请求:明确指向
<project_root>/ROADMAP.md;引用相关章节名称(Current Milestone、Milestones、Plan History 或 Change Log);若文件缺失,先创建再引用。
定制工作流:当用户要求定制此技能时,使用确定性流程:读取活动配置;确认目标 profile 与期望行为(milestoneIdStyle、targetStyle、statusValues、子里程碑启用/ID 风格/状态模型、负责人/依赖字段、计划历史与变更日志详细程度);提出 2-4 个选项包并给出一个推荐默认值;从模板创建或更新 config/customization.yaml 并设置 schemaVersion: 1、isCustomized: true、profile: <selected-profile>;立即将所选设置应用于路线图输出行为;通过 dry-run 路线图更新进行验证,并报告变更的键与行为差异。
自动化模板:在自动化提示中使用 $project-roadmap-manager,以便 Codex 一致地应用路线图更新规则。可填充的 Codex App 与 Codex CLI(codex exec)模板(包括有界编辑护栏与占位符)见 references/automation-prompts.md。
适用场景
- 新项目初始化时建立路线图。
- 计划被接受或完成时更新路线图。
- 里程碑或版本路线图设定或变更时。
- 里程碑达成、受阻或取消范围时。
- 需要引用或查询路线图时。
限制
- 质量要求:保留已有有用路线图内容;所有日期字段使用 ISO 日期格式(YYYY-MM-DD);保持编辑最小且确定性;不得在各章节间留下冲突的里程碑状态;若子里程碑禁用,不得要求或修改任何子里程碑章节;若子里程碑启用,强制确定性子 ID 风格与父范围内唯一 ID。
- 定制参考:详细旋钮与示例见 references/customization.md;YAML schema 与允许值见 references/config-schema.md。
- 自动化提示模板见 references/automation-prompts.md。
- 关于收费、价格、平台支持等具体信息,资料中暂未提供。