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