documentation について
さまざまな種類の保守しやすい技術ドキュメントを作成するスキルです。ソフトウェアや運用を記録するチーム向けに、構成、例、更新、リンクの原則を示します。
主な機能
- 01README の構成ガイド
- 02API リファレンスの指針
- 03ランブックの手順
- 04アーキテクチャとオンボーディング文書
- 05読者を意識した執筆原則
活用シーン
- 01プロジェクト README の作成
- 02API エンドポイントとエラーの記録
- 03運用ランブックの執筆
- 04アーキテクチャや導入ガイドの準備
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/documentationを入力して読み込まれたか確認します。
詳細
技術ドキュメント
さまざまな読者や目的に合わせて、明確で保守しやすい技術ドキュメントを作成します。
ドキュメントの種類
README
- これは何か、なぜ存在するのか
- クイックスタート（初回の成功まで 5 分以内）
- 設定と使い方
- コントリビューションガイド
API ドキュメント
- リクエスト／レスポンスの例を含むエンドポイントのリファレンス
- 認証とエラーコード
- レート制限とページネーション
- SDK の例
運用手順書
- この運用手順書を使用するタイミング
- 前提条件と必要なアクセス権
- 手順の詳細
- ロールバック手順
- エスカレーション先
アーキテクチャドキュメント
- 背景と目標
- 図を使った概要設計
- 重要な決定事項とトレードオフ
- データフローと統合ポイント
オンボーディングガイド
- 環境のセットアップ
- 主要なシステムとその連携方法
- よくあるタスクの手順
- 問い合わせ先とその内容
原則
- 読者に合わせて書く — 誰が読み、何を必要としているか？
- 最も役立つ情報から始める — 要点を埋もれさせない
- 説明するより、実例を示す — コード例、コマンド、スクリーンショット
- 最新の状態を保つ — 古くなったドキュメントは、ないよりも悪い
- 重複させず、リンクする — コピーする代わりに、ほかのドキュメントを参照する
コメント
Markdown 対応