about-docs-folder

关于 docs 文件夹

在以下情况下使用此技能

• 在 docs 文件夹中查找有关项目的实用资源或文档。
• 阅读、创建或处理 docs/plans 中的计划。

docs 文件夹

• docs（通常位于项目根目录）可能包含 Agent 执行任务时所需的实用资源。
• docs/plans 包含长期计划，其中有描述、实现细节和检查清单。
  • **重要提示：**计划应视为历史文档，因此不一定是最新的。
  • 如果在 docs/plans 中找不到计划，请检查 AGENTS.md 中是否存在计划/工作项。

计划文件夹结构

docs/plans/
├── 0-sample-plan/
│   ├── PLAN.md
│   └── QA.md
├── 1-{first plan}/
│   ├── PLAN.md
│   └── QA.md
└── 2-{second plan}/
    └── ...

• 每个计划都位于自己的文件夹中，文件夹名称采用 {number}-{plan name in kebab-case} 格式。
  • 编号递增，因此新计划的编号为现有最大编号 + 1。
  • 当前计划通常是编号最大的计划。
• 每个计划文件夹包含：
  • PLAN.md：为 Agent 提供背景信息、步骤检查清单（- [ ] / - [x]）以及如何执行计划的说明。
  • QA.md：Agent 向用户提出的问题。每个问题都使用 ## Question {n} 标题，并带有 ### Answer 子标题；在用户回答前，子标题下显示 (waiting for user answer)。

PLAN.md 示例

• 注意：计划应包含复选框，以便跟踪计划进度。

# {title of the plan}

{context and plan body}

## Execution of plan

- You should only work in the `{branch name}` branch.
- You should git commit and push regularly, particularly after making many code changes.
- After every step you should tick the step off the plan and make sure everything is committed and pushed.
- Be autonomous, but if you need my input then ask for it in [QA.md](QA.md).

QA.md 示例

# Questions from agent to user

## Question 1

### Answer

(waiting for user answer)