AGENTS.md
- In Markdown, image files must be placed in
images/located in the same directory as the Markdown file. - File names in
docs/must use kebab-case (except forAGENTS.md, ID formats such as<XXX-ID>.md, and actual API endpoint names underspecs/api/). - Documents in
docs/(except forAGENTS.md) must include frontmatter withname(filename),description(1-line summary),timestamp(date in YYYY-MM-DD format), andai(authorship level:none[human only],ai-assisted[human written, AI proofread],ai-coauthored[human designed, AI written], orai-generated[AI created]). - References (links) to
<workspace>(.local/workspace/) are strictly forbidden indocs/. - Files under
wiki/(wiki files) must NOT be referenced (linked) from documents indocs/. - As a general rule, references (links) from tracked documents (追跡対象) to non-tracked documents (非追跡対象) are prohibited.
- Documents classified into layers (L1 to L5) must restrict outgoing links to the same layer and adjacent layers (within ±1 layer: $L_{n-1} \sim L_{n+1}$). Links spanning 2 or more layers are prohibited. Documents outside the layer definition (e.g. guides, tools, decision records) are exempt.
- Based on the Single Source of Truth (SSOT) principle, exactly one canonical (primary) source file must exist for each piece of information, and all other occurrences (ledgers, dashboards, indices) must be views and references.
- Diagrams must be created using Mermaid unless otherwise specified.
- For directory layout and available guides, refer to directory-structure.md.
- For the overall development process and guide map, refer to document-development-guide.md.
文書インデックス
AI エージェントおよび開発者が、設計書、ガイドライン、台帳など各種ドキュメントの役割、配置、参照先への誘導を管理・参照するためのインデックスです（定義ファイル: docs/documents.md, docs/documents.project.md）。
mq を活用した段階的開示（Progressive Disclosure）に対応しており、mise タスクを実行することでセクション一覧の取得および個別詳細の抽出が可能です。
- 一覧取得:
mise run aidev:index:documents-sections - 詳細抽出:
mise run aidev:index:documents-section "<AIDEV-DOCUMENT-ID>: <description>"
定義済みID形式リスト
| ID形式 | ID例 | 概要 | 使用場所 |
|---|---|---|---|
<USECASE-ID> | USECASE-001 | ユースケース ID | docs/usecases/, docs/backlog/usecase.md |
<M-ID(1)> | M-1 | マイルストーン ID（1 桁連番） | docs/plan.md |
<PHASE-ID> | PHASE-001 | フェーズ ID | docs/plan.md |
<F-ID(1)> | F-1 | 機能・feature ID（1 桁連番） | docs/usecases/, docs/backlog/ |
<SPEC-ID> | SPEC-001 | 機能仕様書 ID | specs/ |
<SPEC-I-ID> | SPEC-I-001 | 増分機能仕様書 ID | コンポーネント配下の specs/incremental/ |
<SPEC-C-NAME> | SPEC-C-error-handling | 共通仕様 ID / ファイル名 | 増分仕様書からの参照 |
<TRACK-ID> | TRACK-001 | Track / サブスライス ID | docs/backlog/implementations/ |
<ISSUE-ID> | ISSUE-001 | 課題・不具合 ID | 各コンポーネントの backlog/issues/, backlog/status.tsv |
<TODO-ID> | TODO-001 | TODO ID | 各コンポーネントの backlog/todos/, backlog/status.tsv |
<DR-ID> | DR-001 | 意思決定記録 ID | docs/decision-records/ |
<AIDEV-TOOL-ID(1)> | AIDEV-TOOL-1 | 共通ツール・アクション ID（1 桁連番） | docs/tools.md |
<AIDEV-DOCUMENT-ID(1)> | AIDEV-DOCUMENT-1 | 文書 ID（1 桁連番） | docs/documents.md |
<AIDEV-ACTION-ID(1)> | AIDEV-ACTION-1 | アクション ID（1 桁連番） | docs/actions.md |
<TOOL-ID(1)> | TOOL-1 | プロジェクト固有ツール・アクション ID（1 桁連番） | docs/tools.project.md |