概要
Docs Map
Signal Foundry docs を人間と agent が迷わず使うための入口、読み順、カテゴリの役割をまとめます。
このページの内容6項目
Signal Foundry docs は、実行前に正しい入口を選び、実行後に JSON contract と復旧手順を確認するための navigation surface です。
人間は job から入り、agent は /llms.txt から入り、どちらも最後は sf ... --json の結果で成功か失敗かを判断します。
まず選ぶ入口
| やりたいこと | 最初に読む | 次に読む |
|---|---|---|
| CLI を入れて最初の成功まで進む | Install sf CLI | Quick Start |
| credit の無料 / 有料境界を確認する | Credit Schedule | GET /credits/balance |
| source と evidence の出所を確認する | Data Provenance | Market Research |
| 条件から営業候補や調査対象 List を作る | 営業リスト作成の前段 | List Workspace Loop |
| 市場や競合を横断して調べる | 市場調査 | 競合調査 |
| 持ち込み CSV / 外部 source から始める | List Workspace Loop | Quick Start |
| Claude Code / Codex に任せる | Claude Code / Codex で始める | Codex に docs を渡して進める |
| API を直接組み込む | API overview | OpenAPI Endpoint Inventory |
| 今使える data / filter / API / CLI を確認する | Data Capability Map | Commands & Flags |
| 失敗から復旧する | Troubleshooting | 低ヒット検索の見直し方 |
最初に確認する状態
最初に開く docs がどれであっても、実行面は次の 3 つで揃えます。
sf version --json --check-update sf auth show --json sf data capabilities --json
ここで確認する key:
effectiveBaseUrleffectiveApiKeyPreviewconfigPathcontract_versioncapabilities[].source_idcapabilities[].statuscapabilities[].filters[]capabilities[].pricingcapabilities[].limitations[]
これらが見えない場合は、workflow に進む前に Install sf CLI と Quick Start を直します。surface の最新確認は Data Capability Map に集約します。
docs の構成
| カテゴリ | 役割 | 入れてはいけないもの |
|---|---|---|
| Start | install、auth、最初の成功、agent setup | API endpoint の詳細一覧 |
| Workflows | user job から入る手順 | command flag の網羅 reference |
| CLI | agent が実行する正本 | product overview や長い背景説明 |
| API | HTTP integration contract | tutorial だけで終わる説明 |
| Product Concepts | surface、境界、mental model、data provenance、credit schedule | workflow の手順本体 |
| Troubleshooting | error / warning / weak result からの復旧 | 成功時の通常手順 |
迷った場合は、workflow から入り、必要になった時だけ CLI reference や API reference へ移動します。
agent routing の原則
agent はこの順で進みます。
read /llms.txt -> check sf version --json --check-update -> check sf auth show --json -> read sf data capabilities --json -> verify capabilities[].source_id/status/filters -> check credit schedule when execution may save rows / columns / evidence -> run sf list plan "<query>" --json -> estimate / candidates / materialize / enrich / export -> if weak or unsupported, ask human instead of silent 0
agent に渡すページは、説明が多い page ではなく、次コマンド、期待 key、復旧手順が揃っている page を選びます。
このページで扱わないこと
- Mintlify / OpenAPI 移行の設計判断
- database や billing provider の実装詳細
- 公開利用者が直接実行しない開発環境の setup
これらは product docs refresh の探索文書や developer docs に分け、public docs の主導線には置きません。
次に進む
初回なら Quick Start に進みます。API integration から始める場合は API overview と OpenAPI Endpoint Inventory を開き、agent に渡す場合は Essential Commands、Credit Schedule、Troubleshooting を一緒に渡してください。