jackin-research について
調査ブリーフに基づき、ウェブとコードベースの根拠を用いて、未解決の問いやロードマップのテーマに関する複数ページの調査資料を作成するスキルです。設計判断は行わず、十分な調査が必要な場合に使います。
主な機能
- 01調査ブリーフの作成または読み込み
- 02ウェブとコードベースの根拠収集
- 03複数ページの調査資料作成
- 04章とサイドバーのメタデータ整理
- 05ドキュメント検査の実行
活用シーン
- 01十分な調査が必要な問いの検討
- 02ロードマップテーマの根拠整理
- 03小規模な調査結果のロードマップ項目への記録
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ jackin-project/ jackin-dev --skill jackin-researchインストール後、Claude Code で/jackin-researchを入力して読み込まれたか確認します。
同梱ファイルagents/openai.yaml
詳細
jackin-research
オープンな疑問やロードマップのトピックについて、独立した調査資料を作成します。jackin❯ のドキュメントサイトで公開する複数ページの成果物です。ブリーフ主導で、まずブリーフを作成し、その後に調査を実行します。証拠(ウェブ+コードベース)を収集して統合しますが、製品設計の決定は行いません。
参考実装:jackin❯ リポジトリの docs/content/docs/research/token-optimization-research/。
使用する場合
- 担当者が、相応の規模の調査に対して
jackin-research <slug>を実行する場合。
使用しない場合
- ロードマップ項目の設計判断 →
jackin-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 対応