about-docs-folder

docs フォルダーについて

このスキルを使用する場面

• プロジェクトに関する有用なリソースやドキュメントを docs フォルダーで探す場合。
• docs/plans にある計画を読んだり、作成したり、作業したりする場合。

docs フォルダー

• docs（通常はプロジェクトのルートにあります）には、タスクの実行時にエージェントに役立つリソースが含まれていることがあります。
• 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：エージェント向けのコンテキスト、手順のチェックリスト（- [ ] / - [x]）、計画の実行方法に関する指示。
  • QA.md：エージェントからユーザーへの質問。各質問には ## Question {n} の見出しと、ユーザーが回答するまで (waiting for user answer) と記載された ### 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)