adr-generator について
adr-generator は技術文書向けのスキルです。段階的な案内を提供し、文書に関するコードや設定を生成・検証します。
主な機能
- 01技術文書の段階的な案内
- 02アーキテクチャ文書の支援
- 03API文書の支援
- 04コードと設定の生成
- 05一般的な標準に基づく検証
活用シーン
- 01アーキテクチャ文書について相談する
- 02API文書の資料を準備する
- 03一般的な標準に照らして文書の出力を確認する
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/adr-generatorを入力して読み込まれたか確認します。
詳細
ADR Generator
概要
このスキルは、技術ドキュメント分野における ADR Generator のタスクを自動で支援します。
使用するタイミング
次の場合に、このスキルが自動的に有効になります。
- リクエストで「adr generator」と言及したとき
- ADR Generator のパターンやベストプラクティスについて質問したとき
- API ドキュメント、ユーザーガイド、アーキテクチャドキュメント、ドキュメントの自動化を含む技術ドキュメントのスキルについて支援が必要なとき
手順
- ADR Generator の手順を段階的に案内します
- 業界のベストプラクティスとパターンに従います
- 本番環境で使用できるコードと設定を生成します
- 一般的な標準に照らして出力を検証します
例
例：基本的な使い方 リクエスト：「ADR Generator を手伝ってください」 結果：手順を段階的に案内し、適切な設定を生成します
前提条件
- 関連する開発環境が設定されていること
- 必要なツールやサービスにアクセスできること
- 技術ドキュメントの概念を基本的に理解していること
出力
- 生成された設定とコード
- ベストプラクティスの推奨事項
- 検証結果
エラー処理
| エラー | 原因 | 解決策 |
|---|---|---|
| 設定が無効 | 必須フィールドが不足しています | 必須パラメーターについてドキュメントを確認してください |
| ツールが見つかりません | 依存関係がインストールされていません | 前提条件に従って必要なツールをインストールしてください |
| アクセスが拒否されました | アクセス権限が不足しています | 認証情報と権限を確認してください |
リソース
- 関連ツールの公式ドキュメント
- ベストプラクティスガイド
- コミュニティのサンプルとチュートリアル
関連スキル
技術ドキュメントスキルカテゴリの一部です。 タグ：ドキュメント、markdown、api-docs、readme、テクニカルライティング
コメント
Markdown 対応