---
name: guide-generator
description: Generate a structured markdown guide/outline and draft chapters based on a given topic and output directory. Use when the user requests to create outlines, manuals, tutorials, or guides for specific software, frameworks, or technical topics.
argument-hint: <topic> <output-directory>
---

# Guide Generator

このスキルは、指定された技術的なトピックに関する構造化された解説書（ガイド）を自律的に作成するための手順を提供します。

## Quick start

トピック（例：「DockerとKubernetes」）と出力先ディレクトリ（例：`docs/work/k8s/`）が与えられた場合、以下のステップを順に実行して解説書を作成します。

## Workflows

### ステップ 1: 全体構成（アウトライン）の設計と作成

1.  指定されたトピックについて、全体の章構成（例：「入門編」と「実施編」などのレベル分け）を設計します。
2.  出力先に親となるアウトラインファイル（例: `guide-outline.md` などの分かりやすい名前）を作成します。

### ステップ 2: 章ごとの個別ファイルの作成（簡潔な草案）

1.  設計した章ごとに個別のMarkdownファイルを同じディレクトリに作成します（例: `intro_01_introduction.md`, `action_05_advanced.md` など）。
2.  最初は、各章の各セクション（H2レベルの見出し）の下に簡潔な概要（2〜3行）のみを記述します。

### ステップ 3: 本文の執筆とコード例の追加

1.  各章のファイルを更新し、各セクションの解説を詳細に記述します。
2.  **記述スタイル（必須ルール）**:
   -   必要なことは漏れなく記述し、必要でないことは一切記述しない。
   -   中学生でも読めるように、やさしい言葉遣いにする。
   -   パラグラフは600文字以内とし、1つのパラグラフは1つのトピックに絞る。
   -   無駄な前置きや強調、装飾は不要。
3.  **コード例**: 必要に応じて、実際に動作するプログラミングコード（Python等）のコードブロックを追加します。

### ステップ 4: リンクの接続

1.  親のアウトラインファイルの各章見出しから、作成した個別の章ファイルへの相対リンクを設定します。
   -   例: `### [1. はじめに](./intro_01_introduction.md)`
   -   リンク切れが発生しないように確認してください。

### ステップ 5: 自己レビューと修正

1.  作成した解説書とソースコードを自己レビューし、以下の項目をチェックします。
   -   論理的な矛盾や記述漏れがないか。
   -   コード例の変数名、関数の戻り値、ライブラリの使い方が正しく、動作可能か。
   -   タイポや不自然な表現がないか。
2.  検出した問題を修正し、`.review/` ディレクトリ以下に対応するレビューレポートを作成・保存します。
