Work Documentation

Appearance

AGENTS.md ​

AI エージェントがドキュメントを作成・編集する際は、目的に応じて docs/guide/ 配下の各種ガイドラインおよびテンプレート（XXX-guide.md）を必ず参照し、記述フォーマットや運用ルールを統一してください。なお、docs/guide/ は aidev-template 専用 のガイド・テンプレート群であり、各プロジェクト固有の開発資料・マニュアル類は docs/development/ 配下に配置します。

ドキュメント作成・編集時の参照ルール ​

  • ガイドの参照必須化: ドキュメント（設計書、仕様書、計画書、実装タスク、提案書等）を作成・更新する際は、下記インデックスから対応する XXX-guide.md を参照し、定義されたテンプレート・規約に従うこと。
  • フロントマターの記述: AGENTS.md を除くすべてのドキュメントにおいて、name, description, timestamp（YYYY-MM-DD 形式）, ai 属性をフロントマターに必ず記述すること。
  • docs/AGENTS.md の遵守: ディレクトリ構成、画像配置ルール、用語定義、セルフチェックリスト等の全般規約は docs/AGENTS.md を遵守すること。

ガイドライン・テンプレート インデックス ​

1. 全体プロセス & 設計規約 ​

  • document-development-guide.md ドキュメント駆動開発（DDD）および仕様駆動開発（SDD）の基本原則、設計・開発フェーズの全体プロセス、反復開発、縦切り実装ロードマップ規約。

  • document-status-guide.md ドキュメントステータス定義、ライフサイクル遷移、管理場所、フロントマター項目、レビュー連携ルール。

  • document-design-guide.md 設計ドキュメント（全体設計および各ソフトウェアコンポーネント設計）の作成基準と記述フォーマット。

  • document-implementation-guide.md 開発・実装ドキュメント（backlog/）の作成規約および運用ルール。

  • directory-structure.md プロジェクトの標準ディレクトリ構成および各ディレクトリ・ファイルの役割と配置規則。

  • commit-message.md コミットメッセージのフォーマット、ヘッダー部構文、prefix分類、参照規約。

  • aidev-template-guide.md aidev-template の基本コンセプト、環境セットアップ、および提案書によるフィードバックワークフロー。

  • mise-guide.md miseタスクの運用方針、タスク設定ファイル（永続・一時・テンプレート）の役割分担、およびmiseタスクの定義・実行ガイドライン。

2. 設計ドキュメントテンプレート (docs/ 配下) ​

  • concept-guide.md コンセプト文書（Concept）作成・編集時に参照するテンプレート。

  • architecture-guide.md 全体アーキテクチャ設計書（Architecture）作成・編集時に参照するテンプレート。

  • design-guide.md コンポーネント詳細設計書（Design）作成・編集時に参照するテンプレート。

  • specification-guide.md 機能仕様書（Specification / SPEC-XXX）作成・編集時に参照するテンプレート。

  • usecase-guide.md ユースケース定義書（USECASE-XXX）作成・編集時に参照するテンプレート。

  • decision-record-guide.md 意思決定記録（Decision Record / DR-XXX）作成・編集時に参照するテンプレート。

  • proposal-template.md 改善提案書（Proposal）作成・編集時に参照するテンプレート。

  • tools-guide.md 開発ツールガイド（docs/tools.md）作成・編集時に参照するガイドラインおよびテンプレート。

3. 計画 & ロードマップ ​

4. 実装タスク & 課題・管理ドキュメント ​

  • backlog-task-guide.md 実装タスク詳細（Task）作成・編集時に参照するテンプレート。

  • backlog-issue-guide.md 課題・不具合管理書（Issue）作成・編集時に参照するテンプレート。

  • backlog-todo-guide.md TODO管理書（TODO）作成・編集時に参照するテンプレート。