file-todos

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

File-based todo tracking

基于文件的待办事项追踪

File naming convention

文件命名规范

{issue_id}-{status}-{priority}-{description}.md
  • issue_id: Sequential number (001, 002, 003...) -- never reused
  • status:
    pending
    (needs triage),
    ready
    (approved),
    complete
    (done)
  • priority:
    p1
    (critical),
    p2
    (important),
    p3
    (nice-to-have). Mapping from the
    ia-code-review
    severity scale: Critical→p1, Important→p2, Medium→p3, Minor→p3.
  • description: kebab-case, brief description
Examples:
001-pending-p1-mailer-test.md
,
002-ready-p1-fix-n-plus-1.md
,
005-complete-p2-refactor-csv.md
{issue_id}-{status}-{priority}-{description}.md
  • issue_id:连续编号(001、002、003……)——绝不重复使用
  • status
    pending
    (待分类)、
    ready
    (已批准)、
    complete
    (已完成)
  • priority
    p1
    (关键)、
    p2
    (重要)、
    p3
    (锦上添花)。与
    ia-code-review
    严重程度映射:Critical→p1,Important→p2,Medium→p3,Minor→p3。
  • description:kebab-case格式,简短描述
示例:
001-pending-p1-mailer-test.md
002-ready-p1-fix-n-plus-1.md
005-complete-p2-refactor-csv.md

File Structure

文件结构

Use todo-template.md as a starting point. YAML frontmatter:
yaml
---
status: ready              # pending | ready | complete
priority: p1               # p1 | p2 | p3
issue_id: "002"
tags: [typescript, performance, database]
dependencies: ["001"]      # Issue IDs this is blocked by
---
Required sections: Problem Statement, Findings, Proposed Solutions, Recommended Action, Acceptance Criteria, Work Log
Optional sections: Technical Details, Resources, Notes
todo-template.md为起点。YAML前置元数据:
yaml
---
status: ready              # pending | ready | complete
priority: p1               # p1 | p2 | p3
issue_id: "002"
tags: [typescript, performance, database]
dependencies: ["001"]      # Issue IDs this is blocked by
---
必填章节:问题陈述、发现结果、提议方案、推荐行动、验收标准、工作日志
可选章节:技术细节、资源、备注

Key Distinctions

关键区别

File-todos system (this skill): Markdown files in
todos/
directory for development/project tracking. Used by humans and agents.
Application Todo model: Database model for user-facing task management. Different from this file-based system.
TodoWrite tool: In-memory task tracking during agent sessions. Temporary, not persisted to disk.
文件待办系统(本技能):存储在
todos/
目录中的Markdown文件,用于开发/项目追踪。供人类和Agent使用。
应用待办模型:面向用户的任务管理数据库模型,与本文件系统不同。
TodoWrite工具:Agent会话期间的内存中任务追踪。临时存储,不持久化到磁盘。

Verify

验证

Before considering a todo file correctly written, confirm:
  • issue_id
    is unique and sequentially the next number in
    todos/
    (never reused).
  • All required frontmatter fields are present:
    status
    ,
    priority
    ,
    issue_id
    .
  • status
    and
    priority
    values match the filename and their enums (
    pending|ready|complete
    ,
    p1|p2|p3
    ).
在确认待办文件编写正确之前,需检查:
  • issue_id
    唯一且为
    todos/
    中的下一个连续编号(绝不重复使用)。
  • 所有必填前置元数据字段均存在:
    status
    priority
    issue_id
  • status
    priority
    的值与文件名及枚举值匹配(
    pending|ready|complete
    p1|p2|p3
    )。

References

参考资料

  • workflows.md - Creating, triaging, dependencies, work logs, completing todos, integration table
  • quick-reference.md - Bash commands for finding work, dependencies, searching
  • todo-template.md - Template for new todo files
  • workflows.md - 创建、分类、依赖关系、工作日志、完成待办事项、集成表
  • quick-reference.md - 用于查找工作、依赖关系、搜索的Bash命令
  • todo-template.md - 新待办文件模板