mcpField
A
analysis-documentation

analysis-documentation

github.com/nimrodfisherデータ・データベース504220 回インストール5 週間前に更新
リポジトリ

analysis-documentation について

完了した分析を、関係者への共有、引き継ぎ、レビュー、再利用に向けて構造化した文書にまとめるスキルです。業務背景、データ、手法、結果、再現手順を記録します。

主な機能

  1. 01読者と範囲の調整
  2. 02業務背景と意思決定の整理
  3. 03データソースと手法の記録
  4. 04結果、提案、再現手順
  5. 05構造化された文書テンプレート

活用シーン

  1. 01関係者への分析共有の準備
  2. 02別の分析担当者への引き継ぎ
  3. 03定期分析の再利用に向けた保管
  4. 04ピアレビューや監査の準備

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/nimrodfisher/data-analytics-skills --skill analysis-documentation

インストール後、Claude Code で/analysis-documentationを入力して読み込まれたか確認します。

同梱ファイルassets/analysis_doc_template.mdreferences/audience_depth_guide.md

詳細

分析ドキュメント

使用する場面

  • ステークホルダーと共有する前に分析を仕上げる場合
  • 分析を別のチームメンバーや将来の自分に引き継ぐ場合
  • 定期的に行う分析をアーカイブし、同じ手順で再実行できるようにする場合
  • ピアレビューや正式な監査に備える場合
  • 探索的なノートブックを参照用ドキュメントに変換する場合

プロセス

  1. 対象読者と範囲を確認する — 主な読者が技術担当者(データチーム)、ビジネス関係者(ステークホルダー)、またはその両方のどれに当たるかを判断します。対象読者が混在する場合は、階層構造を使用します。調整方法については、references/audience_depth_guide.md を参照してください。
  2. ビジネスコンテキストのセクションを作成する — ビジネス上の問い、分析を依頼したステークホルダー、分析結果が役立つ意思決定、および成功基準を記載します。
  3. データソースを記録する — 各ソースについて、テーブルまたはファイル、期間、行数、主要な列、および既知の品質上の問題や適用した除外条件を記録します。
  4. 手法のセクションを作成する — 分析アプローチ、ツールとライブラリのバージョン、主要な前提、重要な判断(検討した代替案を含む)を説明します。前提条件のログがある場合は参照します。
  5. 結果を記録する — 主要な指標と統計情報を含め、説明的なキャプションを付けたビジュアライゼーションを埋め込むかリンクし、重要度の高い順に調査結果を提示します。
  6. インサイト、推奨事項、再現性のセクションを作成する — 各調査結果をビジネス上の意味と次のアクションに結び付けます。分析を再現するために必要な手順(データへのアクセス、環境、実行順序)を記録します。構成には assets/analysis_doc_template.md を使用してください。

スキルに必要な入力

  • 最終版のコード(SQL、Python、ノートブック)と出力(グラフ、テーブル)
  • ビジネス上の問いとステークホルダーの背景情報
  • 特定済みの主要な調査結果と推奨事項
  • データソースの詳細(テーブル、期間、サンプルサイズ)
  • 使用したライブラリとツールのバージョン

出力

  • assets/analysis_doc_template.md — コンテキスト、データ、手法、結果、再現性を網羅した完成版の分析ドキュメント
  • リンクまたは埋め込み形式のビジュアライゼーションとコード参照

コメント