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