← ClaudeAtlas

create-doclisted

Create a general-purpose technical documentation page as a single self-contained HTML file using the tech-docs design system. Use when the user wants a polished HTML document that doesn't fit ADR or spec (runbook, postmortem, onboarding guide, internal handbook, research note, meeting summary, etc.) — e.g. "ドキュメントを HTML で作って", "runbook を書いて", "ポストモーテムをまとめたい".
9uiLe/plugins · ★ 0 · Web & Frontend · score 72
Install: claude install-skill 9uiLe/plugins
# create-doc — 汎用ドキュメントを書く このスキルは **ADR / 仕様書以外の汎用ドキュメントを 1 枚の HTML として生成** します。 完成物はブラウザでそのまま開ける自己完結ファイル + 共有アセットの組み合わせです。 ユースケース例: runbook、postmortem、オンボーディングガイド、調査メモ、議事録のまとめ、社内ハンドブック、技術リサーチノートなど。 > **どのスキルを使うか迷ったら** > - 「採用した設計選択を後から参照可能な形で残したい」 → `create-adr` > - 「これから作るものの設計を提案・議論したい」 → `create-spec` > - **それ以外の技術ドキュメント全般** → このスキル --- ## 1. 進め方 (必ずこの順番で) 1. **ドキュメント種別の確認** - ユーザーが種別 (runbook / postmortem / onboarding / 調査メモ / その他) を明示していなければ確認する。 - 種別によって章立てが変わる (§2 参照)。 2. **対象ディレクトリの確認** - 出力先が指定されていなければ、種別��応じて提案する: - runbook → `docs/runbooks/` - postmortem → `docs/postmortems/` - その他 → `docs/` - 既存ディレクトリがあれば命名規則を踏襲する。 3. **必要情報を 1 メッセージにまとめて確認** ユーザーが提供済みのものは再質問しない。不足分のみ 1 度で聞く: - タイトル、Owner、最終更新日 - 種別 (§2 の章立てを選ぶため) - 目的 (このドキュメントが読まれる場面) - 本文に必要な要素 (手順 / 図 / 表 / コードサンプル / メトリクス) 4. **生成** - `${PLUGIN_ROOT}/shared-assets/templates/skeleton-doc.html` を雛形にする。 - 種別に応じて章立てを差し替える (§2)。 - 出力先に書き出し、`system/` サブディレクトリに共有アセットをコピー (§3)。 5. **報告** - 生成パスとブラウザでの確認方法を案内する。 --- ## 2. 種別ごとの推奨章立て 雛形の Summary / Details / References を、種別に応じて以下に置き換える。 ### 2.1 Runbook (運用手順書) ``` h2: 概要 … いつ・誰が・何のために使う手順か h2: Prerequisites … 事前条件 (権限・ツール・前提) h2: Procedure … 手順 (番号付きリスト + コード例) h2: Verification … 成功確認 (メトリクスやコマンド) h2: Rollback … 戻し方 h2: Troubleshooting … よくある失敗パターン (callout--warning) h2: References ``` ### 2.2 Postmortem (障害事後分析) ``` h2: Summary … 何が起きたか 2〜3 行