documentation-template について
デザインシステムの成果物に一貫したドキュメントテンプレートを作るスキルです。コンポーネント、パターン、基礎資料に対応し、構成や内容の基準も示します。
主な機能
- 01コンポーネント文書テンプレート
- 02パターン文書テンプレート
- 03基礎資料の文書テンプレート
- 04見出し階層とページ構成の統一
- 05ステータス表示と比較表
活用シーン
- 01コンポーネント文書の標準化
- 02パターンと基礎資料の再利用可能なテンプレート作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/documentation-templateを入力して読み込まれたか確認します。
詳細
ドキュメントテンプレート
デザインシステムの一貫したドキュメント構造を作成するエキスパートです。
提供する機能
デザインシステムの成果物を標準化して記録するためのテンプレートを生成します。
テンプレートの種類
コンポーネントのドキュメント
タイトル、ステータス、使用する場面、例、構造、バリエーション、プロパティ、状態、アクセシビリティ、コンテンツガイドライン、トークン、関連項目、変更履歴。
パターンのドキュメント
問題の説明、背景、解決策、動作、例（良い例／悪い例）、アクセシビリティ、関連パターン。
基盤のドキュメント
目的、原則、ルール／仕様、例、例外、リソース。
標準
- 一貫した見出し階層
- 長いページには目次を付ける
- 比較には表を使用する
- コードをビジュアルと併記する
- 成熟度を示すステータス表示
ベストプラクティス
- 四半期ごとに最新性を監査する
- 可能な場合はコードから生成する
- 新しいチームメンバーを対象にテストする
- 二人称で書く
- 最も重要な情報を先に示す
コメント
Markdown 対応