tracedocs について
tracedocs は、コードベースから根拠を明示したドキュメント一式を作成するスキルです。運用に関する記述の出典と確度を示し、不明点を記録して生成物を検査します。
主な機能
- 01コードベースの構成と兆候を分析
- 02根拠を整理し確度を付与
- 03マニュアルと index.json を生成
- 04手順を捏造せず不足を記録
- 05パス、コマンド、秘密情報を検査
活用シーン
- 01不慣れなコードベースの文書化
- 02運用・デプロイマニュアルの作成
- 03AI エージェント向けの知識引き継ぎ
- 04出典を追跡できる学習ガイドの作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ davepoon/ buildwithclaude --skill tracedocsインストール後、Claude Code で/tracedocsを入力して読み込まれたか確認します。
詳細
tracedocs
あらゆるコードベースを、根拠に基づくドキュメント一式(概要、操作、デプロイ、学習、アーキテクチャ、API/データ、トラブルシューティング、メンテナンス)と、AI エージェント向けの機械可読な index.json に変換します。操作やデプロイに関するすべての主張には、出典ファイルと信頼度ラベル(Verified / Inferred / Unknown / Needs confirmation)が付けられます。デプロイ手順を捏造することはなく、不足情報として記録します。
スキル一式、リファレンス、テンプレート、検証済みの出力例: https://github.com/wxggzz/tracedocs (MIT)。
このスキルを使う場面
- 不慣れなコードベースへのオンボーディングや、そのドキュメント作成
- 操作、デプロイ、メンテナンス用の、リポジトリ内で長期的に利用できるドキュメントの作成
- AI エージェント向けのナレッジ引き継ぎの準備(
index.jsonを含む) - リポジトリを、記載内容の出典を追跡できる学習ガイドに変換
このスキルが行うこと
- コードベースを分析します(スタック、スクリプト、エントリーポイント、環境変数名、デプロイの兆候、テスト)。
- 信頼度ラベル付きの根拠マップ(ソースマップ、前提、生成ログ)を作成します。
- Markdown マニュアルと
index.jsonマニフェストを作成します。デプロイ手順を捏造することはありません。 - 品質チェックを実行します(パスの存在、出典のあるコマンド、シークレット値が含まれていないこと、不足情報の記録)。
使い方
基本的な使い方
Use tracedocs to generate evidence-grounded study docs for this repository. Write the output to study-docs/.
例
ユーザー:「tracedocs を使って ./my-app のドキュメントを作成してください」
このスキルはリポジトリをスキャンし、study-docs/ パッケージ(00~10 のマニュアル、index.json、_evidence/)を作成します。操作に関する各主張には出典を示し、信頼度を記載します。また、検証できない内容(例:「リポジトリにデプロイ設定が見つかりません」)を明示します。
コメント
Markdown 対応