Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

AGENTS.md

  • 本ディレクトリ(docs/guide/)には、aidev-template の標準開発プロセス、ガイドライン、および各種ドキュメントテンプレート(XXX-guide.md, XXX-template.md)を配置します。
  • ガイドラインおよびテンプレートの作成・編集にあたっては、フロントマター(name, description, timestamp, ai)を必ず記述してください。

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

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タスクの定義・実行ガイドライン。

  • testing-guide.md テストの分類(単体・コンポーネント[統合]・パフォーマンス・セキュリティ・汎用検証)、配置規則、および検証チェックリスト(チェックリスト・テスト仕様書)の作成ガイドラインと記述テンプレート。

  • local-guide.md AIエージェントの作業領域・記憶領域(.local/)の役割、内部構造(workspace, memory, worklog等)、および連携スキルの運用ガイドライン。

2. 設計ドキュメントテンプレート

  • 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)作成・編集時に参照するテンプレート。

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

3. 計画 & スライス

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

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

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

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