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