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 | operating-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 例 - 番号付きリストのサブリストのインデントが浅い:
1. **データとしてのパターン**
- すべてのパターンがデータ構造として表現される
- パターン間の境界が明確
OK 例:
1. **データとしてのパターン**
- すべてのパターンがデータ構造として表現される
- パターン間の境界が明確
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 : プロジェクト全体の進捗確認Marp Markdown スライドデッキの作成・拡張・再生成を支援。PlantUML 図表、AI 画像バリアント、漫画画像バリアント、PPTX/HTML 出力に対応。`tmp/k2works-wiki/スライド/YYYYMMDD` などの日本語技術スライドフォルダの構築・更新、コードサンプル追加、ビジュアル要約スライド追加、`スライド.images.md` / `スライド.images.ai.md` / `スライド.images.ai.manga.md` の生成、Marp HTML/PPTX デッキの再生成時に使用。
テスト駆動開発から始めるプログラミング入門」の対話式チュートリアル。FizzBuzz を題材に TDD の Red-Green-Refactor サイクルを 14 言語で体験する。「TDD を練習したい」「FizzBuzz で TDD を学びたい」「テスト駆動開発の入門をしたい」「Java で TDD を体験したい」「Python で TDD を始めたい」「プログラミング入門チュートリアルをやりたい」「getting-start-tdd をやりたい」「TDD のハンズオンがしたい」「Red-Green-Refactor を体験したい」といった場面で発動する。TDD チュートリアルやプログラミング入門の要望があれば積極的に使用すること。
ビジネスアーキテクチャ分析を支援。要件定義の前段階として、ビジネスモデルキャンバス、バリューストリーム、ケイパビリティマップ、組織マップ、情報マップ、ビジネスシナリオを作成。「ビジネスモデルを整理したい」「バリューストリームを描きたい」「ケイパビリティマップを作りたい」「事業構造を分析したい」「ビジネスアーキテクチャを分析したい」「BA 分析をしたい」といった場面で発動する。ビジネスの全体像を理解してからシステム要件に落とし込むことで、本当に必要な機能を見極められる。
企業事例（ケーススタディ）の与件文作成を支援。経営戦略・マーケティング・生産管理・財務会計の 4 パターンから選択し、テンプレートのプレースホルダに対応する質問に回答することで与件文を生成する。「企業事例を作りたい」「ケーススタディを書きたい」「与件文を作成したい」「診断士試験の事例問題を作りたい」「仮想企業の事例を整理したい」といった場面で発動する。事例テンプレートに沿って体系的にヒアリングすることで、論理的整合性のある与件文を効率的に作成できる。
企業事例（与件文）を基に企業戦略・事業戦略・機能戦略の 3 階層を体系的に立案。環境分析（SWOT・VRIO・BMC）から始めて、ドメイン定義・成長戦略・競争戦略・価値連鎖・ケイパビリティマップまで、PlantUML を活用した可視化ドキュメントを作成する。「戦略を立案したい」「企業戦略を作りたい」「事業戦略を策定したい」「SWOT 分析をしたい」「VRIO 分析をしたい」「成長戦略を考えたい」「競争戦略を立てたい」「価値連鎖を分析したい」「ケイパビリティマップを作りたい」「診断士試験の戦略分析をしたい」「企業事例から戦略を導出したい」といった場面で発動する。事例と戦略をセットで扱うことで、経営コンサルティングの提案書や中小企業診断士の答案に相当する体系的な戦略ドキュメントを作成できる。
インセプションデッキの作成を支援。プロジェクトの「なぜ」「何を」「どうやって」を 10 の問いで整理し、チーム全体の認識を揃える。「インセプションデッキを作りたい」「プロジェクトの方向性を整理したい」「10 の問いに答えたい」「チームの認識を揃えたい」「プロジェクトを立ち上げる」といった場面で発動する。プロジェクトの方向性を最初に揃えておくことで、後工程での手戻りを大幅に減らせる。