research について
researchは、未解決の問いやロードマップのテーマを扱う、複数ページの調査資料を作成するスキルです。ブリーフに沿ってウェブとコードベースの証拠を集め、文書化します。プロダクト設計の決定は行いません。
主な機能
- 01調査ブリーフの作成
- 02ウェブとコードベースの証拠収集
- 03複数ページの調査資料作成
- 04ブリーフのみや範囲限定の調査
- 05文書構成の検査とビルド
活用シーン
- 01未解決の技術的な問いを調査
- 02ロードマップのテーマを出典付きで研究
- 03調査結果を文書資料として公開
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ jackin-project/ jackin-dev --skill researchインストール後、Claude Code で/researchを入力して読み込まれたか確認します。
詳細
research
未解決の課題やロードマップのトピックについて、jackin' のドキュメントサイトで公開する複数ページの調査資料を作成します。まずブリーフを作成してから、調査を実行します。証拠(ウェブとコードベース)を収集して統合しますが、プロダクトの設計上の決定は行いません。
参考実装:jackin' リポジトリの docs/content/docs/research/token-optimization-research/。
使用する場合
- 運用担当者が
/jackin-dev:research <slug>を実行して、本格的な調査を行う場合。
使用しない場合
- ロードマップ項目の設計上の決定 →
/jackin-dev:brainstorm。 - 簡単な確認 →
deep-researchまたは Explore を直接使用し、調査資料は作成しません。
引数
--brief-only— ブリーフであるprompt.mdxを作成して終了します。後で/goal Follow <brief>を実行して調査します。--in-roadmap— 独立した調査資料ではなく、ロードマップ項目に調査結果を直接記載します(小規模な調査向け)。--web-only/--codebase-only— 情報収集をいずれか一方に限定します。
出力レイアウト(デフォルト:独立したフォルダー)
docs/content/docs/research/<slug>/
├── meta.json # { title, defaultOpen:false, pages:[...] } — sidebar order
├── index.mdx # dossier landing: headline numbers, how-to-read, tier list
├── prompt.mdx # the brief that was run (the spec; carries the /goal run line)
├── NN-*.mdx # numbered chapters (00 summary, 01.. foundations, 10-20 areas, 30+ synthesis)
└── tools/ # optional scripts + own meta.json + index.mdx
親の docs/content/docs/research/meta.json の pages にも <slug> を追加します。大規模な調査は独立したフォルダー(デフォルト)に、小規模な調査は --in-roadmap に記載します。
プロセス
- スコープ設定/ブリーフ作成。 トピック(またはロードマップ項目)をもとに、
prompt.mdxを作成するか、既存のものを読み込みます。ミッション、章の一覧、証拠のルールを定めます。--brief-onlyを指定した場合は、ここで終了します。 - 情報収集。 ウェブは組み込みの
deep-researchを、コードベースは Explore/grep を使用します。外部の主張にはすべて出典 URL を付け、ローカルの数値にはすべて算出方法を記載します。 - 執筆。
index.mdx(主要な数値、読み方、評価リスト)と、固定の手法別レコードスキーマに沿った番号付きの章を作成します。再現用スクリプトがあればtools/にまとめます。 - サイドバーの設定。 調査資料の
meta.jsonと親のresearch/meta.jsonを作成または更新します。 - ドキュメントのチェックとコミット。
docs/からbunのドキュメントチェック(build、check:repo-links、tsc --noEmit、test)を実行します。docs(research):でコミットし、プッシュします。
よくある間違い
- Problem/Why/Design の形式を無理に当てはめる — 調査資料の形式は自由であり、ロードマップ項目ではありません。
- 設計上の決定を行う — それは
brainstormの役割です。 - 出典のない外部の主張や、算出方法が記載されていないローカルの数値。
meta.jsonのpagesとディスク上のファイルが一致していない。
ツール
cargo xtask research scaffold <slug> はフォルダーと meta.json を作成します。cargo xtask research check は pages とディスク上のファイルが一致しているか検証します。通常、調査の実行には外部の /goal Follow <brief> を使用します。
コメント
Markdown 対応