file-todos
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseFile-based todo tracking
基于文件的待办事项追踪
File naming convention
文件命名规范
{issue_id}-{status}-{priority}-{description}.md- issue_id: Sequential number (001, 002, 003...) -- never reused
- status: (needs triage),
pending(approved),ready(done)complete - priority: (critical),
p1(important),p2(nice-to-have). Mapping from thep3severity scale: Critical→p1, Important→p2, Medium→p3, Minor→p3.ia-code-review - description: kebab-case, brief description
Examples: , ,
001-pending-p1-mailer-test.md002-ready-p1-fix-n-plus-1.md005-complete-p2-refactor-csv.md{issue_id}-{status}-{priority}-{description}.md- issue_id:连续编号(001、002、003……)——绝不重复使用
- status:(待分类)、
pending(已批准)、ready(已完成)complete - priority:(关键)、
p1(重要)、p2(锦上添花)。与p3严重程度映射:Critical→p1,Important→p2,Medium→p3,Minor→p3。ia-code-review - description:kebab-case格式,简短描述
示例:、、
001-pending-p1-mailer-test.md002-ready-p1-fix-n-plus-1.md005-complete-p2-refactor-csv.mdFile 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 directory for development/project tracking. Used by humans and agents.
todos/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.
文件待办系统(本技能):存储在目录中的Markdown文件,用于开发/项目追踪。供人类和Agent使用。
todos/应用待办模型:面向用户的任务管理数据库模型,与本文件系统不同。
TodoWrite工具:Agent会话期间的内存中任务追踪。临时存储,不持久化到磁盘。
Verify
验证
Before considering a todo file correctly written, confirm:
- is unique and sequentially the next number in
issue_id(never reused).todos/ - All required frontmatter fields are present: ,
status,priority.issue_id - and
statusvalues match the filename and their enums (priority,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 - 新待办文件模板