Back to Details

project-roadmap-manager

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Project Roadmap Manager

项目路线图管理器

Maintain 
ROADMAP.md
in the project root as the canonical roadmap record. Prefer updating existing sections over appending duplicates, and keep 
Current Milestone
synchronized with the latest accepted plan.
维护项目根目录下的
ROADMAP.md
作为官方路线图记录。优先更新已有章节而非追加重复内容，同时保持
Current Milestone
与最新获批计划同步。

Workflow

工作流

  1. Identify project root and target file:
    • Use 
      <project_root>/ROADMAP.md
      .
    • If root is ambiguous, infer from repository root.
  2. Ensure 
    ROADMAP.md
    exists:
    • If missing, create it using the template in this skill.
  3. Classify the request into one of these event types:
    • Project bootstrap.
    • Plan acceptance/completion.
    • Milestone/version roadmap set or changed.
    • Milestone reached/blocked/de-scoped.
    • Roadmap reference/query.
  4. Apply the event-specific update rules.
  5. Keep all sections internally consistent: 
    • Current Milestone
      matches active milestone in 
      Milestones
      .
    • Plan History
      includes accepted plan snapshots.
    • Change Log
      captures each roadmap mutation with date and reason.
  1. 确定项目根目录与目标文件：
    • 使用
      <project_root>/ROADMAP.md
      。
    • 如果根目录不明确，从仓库根目录推断。
  2. 确保
    ROADMAP.md
    存在：
    • 如果缺失，使用本skill中的模板创建。
  3. 将请求归类为以下事件类型之一：
    • 项目启动。
    • 计划接受/完成。
    • 里程碑/版本路线图设置或变更。
    • 里程碑已达成/受阻/移出范围。
    • 路线图参考/查询。
  4. 应用对应事件的更新规则。
  5. 保持所有章节内部一致： 
    • Current Milestone
      与
      Milestones
      中的活跃里程碑匹配。
    • Plan History
      包含已接受的计划快照。
    • Change Log
      记录每次路线图变更的日期与原因。

ROADMAP.md Template

ROADMAP.md Template

Use this structure when creating a new roadmap:
markdown
undefined
创建新路线图时使用以下结构：
markdown
undefined

Project Roadmap

Project Roadmap

Current Milestone

Current Milestone

  • ID: M1
  • Name: Initial Setup
  • Status: Planned
  • Target Version: v0.1.0
  • Last Updated: YYYY-MM-DD
  • Summary: One-paragraph summary of the currently accepted plan.
  • ID: M1
  • Name: Initial Setup
  • Status: Planned
  • Target Version: v0.1.0
  • Last Updated: YYYY-MM-DD
  • Summary: One-paragraph summary of the currently accepted plan.

Milestones

Milestones

IDNameTarget VersionStatusTarget DateNotes
M1Initial Setupv0.1.0PlannedYYYY-MM-DDBootstrap milestone
IDNameTarget VersionStatusTarget DateNotes
M1Initial Setupv0.1.0PlannedYYYY-MM-DDBootstrap milestone

Plan History

Plan History

YYYY-MM-DD - Accepted Plan (v0.1.0 / M1)

YYYY-MM-DD - Accepted Plan (v0.1.0 / M1)

  • Scope:
  • Acceptance Criteria:
  • Risks/Dependencies:
  • Scope:
  • Acceptance Criteria:
  • Risks/Dependencies:

Change Log

Change Log

  • YYYY-MM-DD: Initialized roadmap.
undefined
  • YYYY-MM-DD: Initialized roadmap.
undefined

Event Handling Rules

事件处理规则

Project Bootstrap

项目启动

  • Create 
    ROADMAP.md
    if absent.
  • Add an initial milestone (
    M1
    unless user provides a different identifier).
  • Add a changelog entry indicating roadmap initialization.
  • 如果
    ROADMAP.md
    不存在则创建。
  • 添加初始里程碑（除非用户提供其他标识，否则默认使用
    M1
    ）。
  • 添加变更日志条目说明路线图已初始化。

Plan Acceptance or Completion

计划接受或完成

  • Update 
    Current Milestone
    to reflect the accepted plan.
  • Add or update corresponding row in 
    Milestones
    .
  • Append an 
    Accepted Plan
    entry in 
    Plan History
    with scope and acceptance criteria.
  • Add a changelog entry summarizing what changed and why.
  • 更新
    Current Milestone
    以反映已接受的计划。
  • 在
    Milestones
    中添加或更新对应行。
  • 在
    Plan History
    中追加包含范围与验收标准的
    Accepted Plan
    条目。
  • 添加变更日志条目，总结变更内容与原因。

Milestone or Version Roadmap Set/Update

里程碑或版本路线图设置/更新

  • Update existing milestone by ID/version if it exists.
  • Add milestone only when no matching milestone exists.
  • Avoid duplicate milestones for the same ID or target version.
  • If the updated milestone is active, sync 
    Current Milestone
    .
  • 如果对应ID/版本的里程碑已存在，则更新现有里程碑。
  • 仅当不存在匹配的里程碑时才添加新里程碑。
  • 避免为相同ID或目标版本创建重复里程碑。
  • 如果更新的是活跃里程碑，同步更新
    Current Milestone
    。

Milestone Reached/Changed

里程碑达成/变更

  • Update milestone status (
    Completed
    , 
    In Progress
    , 
    Blocked
    , 
    De-scoped
    , or 
    Planned
    ).
  • Update 
    Current Milestone
    if active milestone changed.
  • Add a dated note in 
    Change Log
    that captures transition and reason.
  • 更新里程碑状态（
    Completed
    、
    In Progress
    、
    Blocked
    、
    De-scoped
    或
    Planned
    ）。
  • 如果活跃里程碑发生变更，更新
    Current Milestone
    。
  • 在
    Change Log
    中添加带日期的说明，记录状态变更与原因。

Roadmap Reference Requests

路线图参考请求

  • Point explicitly to 
    <project_root>/ROADMAP.md
    .
  • Cite the relevant section name (
    Current Milestone
    , 
    Milestones
    , 
    Plan History
    , or 
    Change Log
    ).
  • If file is missing, create it first, then reference it.
  • 明确指向
    <project_root>/ROADMAP.md
    。
  • 引用相关章节名称（
    Current Milestone
    、
    Milestones
    、
    Plan History
    或
    Change Log
    ）。
  • 如果文件不存在，先创建再引用。

Quality Bar

质量标准

  • Preserve existing useful roadmap content.
  • Use ISO date format (
    YYYY-MM-DD
    ) for all dated fields.
  • Keep edits minimal and deterministic.
  • Never leave conflicting milestone statuses across sections.
  • 保留现有有用的路线图内容。
  • 所有日期字段使用ISO日期格式（
    YYYY-MM-DD
    ）。
  • 保持编辑最小化且结果确定。
  • 绝对不要在不同章节中留下冲突的里程碑状态。

Automation Templates

自动化模板

Use 
$project-roadmap-manager
inside automation prompts so Codex consistently applies the roadmap update rules.
For ready-to-fill Codex App and Codex CLI (
codex exec
) templates, including bounded-edit guardrails and placeholders, use:
  • references/automation-prompts.md
在自动化提示词中使用
$project-roadmap-manager
，以便Codex统一应用路线图更新规则。
如需可直接填充的Codex App和Codex CLI（
codex exec
）模板，包括边界编辑防护与占位符，请使用：
  • references/automation-prompts.md

References

参考资料

  • Automation prompt templates: 
    references/automation-prompts.md
  • 自动化提示词模板：
    references/automation-prompts.md