Menu
設計ドキュメントの一覧表示、進捗確認、内容参照、インデックス更新、Markdown Lint を実行。ドキュメント管理や整備時に使用。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | managing-docs |
| description | 設計ドキュメントの一覧表示、進捗確認、内容参照、インデックス更新、Markdown Lint を実行。ドキュメント管理や整備時に使用。 |
設計ドキュメントの一覧表示、進捗確認、内容参照を行います。
--list : ドキュメント一覧のみを表示--status : ドキュメントの作成状況を詳細表示--read <ファイル名> : 指定したドキュメントの内容を表示--summary : 全ドキュメントの概要を表示--update : docs/index.md と mkdocs.yml を現在のドキュメント構成に合わせて更新--update-index : docs/index.md のみを更新--update-mkdocs : mkdocs.yml のみを更新--lint : Markdown フォーマットをチェックし、違反を自動修正# ドキュメント一覧と進捗確認
# 「設計ドキュメントの一覧と作成状況を確認」
# 特定ドキュメントの参照
# --read tech_stack
# 「技術スタック選定ドキュメントの内容を表示」
# docs/index.md と mkdocs.yml を更新
# --update
# 「現在のドキュメント構成に合わせて両ファイルを更新」
# Markdown フォーマットをチェック・修正
# --lint
# 「タスク項目の前に空行がないなどのフォーマット違反を検出し自動修正」
本プロジェクトのドキュメントは以下の構成で管理されています:
要件定義ドキュメント (docs/requirements/)
requirements_definition.md : 要件定義書（RDRA 2.0）business_usecase.md : ビジネスユースケースsystem_usecase.md : システムユースケースuser_story.md : ユーザーストーリー設計ドキュメント (docs/design/)
architecture_backend.md : バックエンドアーキテクチャarchitecture_frontend.md : フロントエンドアーキテクチャarchitecture_infrastructure.md : インフラストラクチャdata-model.md : データモデル設計domain-model.md : ドメインモデル設計ui-design.md : UI 設計test_strategy.md : テスト戦略non_functional.md : 非機能要件operation.md : 運用要件tech_stack.md : 技術スタック選定--update オプションを使用すると、現在のドキュメント構成に合わせて docs/index.md と mkdocs.yml と 各ディレクトリの index.md を自動更新できます。
docs/index.md の更新内容:
mkdocs.yml の更新内容:
nav セクションを現在のドキュメント構成に合わせて更新各ディレクトリの index.md の更新内容:
--lint オプションを使用すると、Markdown ドキュメントのフォーマットをチェックし、違反を自動修正できます。
チェックルール:
NG 例 - ラベルの直後にリスト:
**受入条件**:
- [ ] ログアウトボタンをクリックするとログアウトできる
OK 例:
**受入条件**:
- [ ] ログアウトボタンをクリックするとログアウトできる
NG 例 - 番号付きリストの直後にサブリスト:
1. **対処**: SMB バージョンを確認
- コントロールパネル > ファイルサービス > SMB で設定
OK 例:
1. **対処**: SMB バージョンを確認
- コントロールパネル > ファイルサービス > SMB で設定
NG 例 - コロンで終わる行の直後にリスト:
PMD はカスタム設定で以下をチェック：
- マジックナンバーの使用
OK 例:
PMD はカスタム設定で以下をチェック：
- マジックナンバーの使用
実行手順:
docs/ 配下の全 Markdown ファイルをスキャン設計ドキュメント一覧
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
docs/requirements/
├─ requirements_definition.md (要件定義書)
├─ business_usecase.md (ビジネスユースケース)
├─ system_usecase.md (システムユースケース)
└─ user_story.md (ユーザーストーリー)
docs/design/
├─ architecture_backend.md (バックエンドアーキテクチャ)
├─ architecture_frontend.md (フロントエンドアーキテクチャ)
├─ data-model.md (データモデル設計)
├─ domain-model.md (ドメインモデル設計)
├─ ui-design.md (UI 設計)
├─ test_strategy.md (テスト戦略)
├─ non_functional.md (非機能要件)
├─ operation.md (運用要件)
└─ tech_stack.md (技術スタック選定)
進捗: 14/14 ドキュメント完成 (100%)
docs/ ディレクトリが存在すること--update 実行前に現在の docs/index.md と mkdocs.yml をバックアップすることを推奨--update-mkdocs を使用する場合、MkDocs がインストールされている必要がある--update でインデックスを同期する--update-mkdocs 後は mkdocs serve でナビゲーションを確認する--lint でフォーマットの一貫性を確保するorchestrating-analysis : 分析フェーズ全体の作業支援analyzing-requirements : 要件定義関連の作業支援analyzing-architecture : アーキテクチャ設計支援tracking-progress : プロジェクト全体の進捗確認バックエンド開発の TDD ワークフロー。Red-Green-Refactor サイクル、インサイドアウトアプローチ、品質チェックリスト。Java/Spring Boot のバックエンド実装時に使用。
フロントエンド開発の TDD ワークフロー。Red-Green-Refactor サイクル、アウトサイドインアプローチ、コンポーネント設計。React/TypeScript のフロントエンド実装時に使用。
分析フェーズ全体のワークフローをオーケストレーション。要件定義から非機能要件まで各 analyzing-* スキルの実行順序を案内。分析フェーズの開始や全体像の把握時に使用。
開発フェーズ全体の TDD ワークフローをオーケストレーション。バックエンド・フロントエンド開発の進め方、Codex 分業体制を案内。開発フェーズの開始や開発手法の確認時に使用。
計画・進捗管理フェーズ全体のワークフローをオーケストレーション。リリース計画、GitHub Project 同期、進捗追跡の実行順序を案内。プロジェクト管理の開始や全体像の把握時に使用。
アプリケーションのリリースワークフロー。品質ゲート、バージョンバンプ、CHANGELOG 生成、git commit + tag を一貫実行。リリース作業やバージョン管理時に使用。