mcpField
R
research

research

github.com/jackin-project生产力3161 次安装4 周前更新
代码仓库

关于 research

research 是一项技能，用于围绕开放问题或路线图主题制作独立的多页研究档案。它以研究简报为依据，收集网页和代码库证据并整理成文档；不负责产品设计决策。

主要功能

  1. 01起草研究简报
  2. 02收集网页与代码库证据
  3. 03编写多页研究档案
  4. 04支持仅写简报及限定范围的研究
  5. 05检查文档结构并运行构建

适用场景

  1. 01调查尚待解答的技术问题
  2. 02为路线图主题开展有来源的研究
  3. 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

同时将 <slug> 添加到父级 docs/content/docs/research/meta.json 的 pages 中。大型研究 → 使用独立目录（默认）；小型研究 → 使用 --in-roadmap。

流程

  1. 确定范围 / 撰写简报。 根据主题（或路线图条目）起草或加载 prompt.mdx：任务、章节列表、证据规则。使用 --brief-only 时，到此为止。
  2. 收集资料。 网页资料通过内置的 deep-research 获取；代码库资料通过 Explore/grep 获取。每条外部主张都必须附带来源 URL；每个本地数据都必须注明获取方法。
  3. 撰写。 编写 index.mdx（关键数据 + 阅读指南 + 分级列表）和按固定的技术记录结构编写的编号章节；将复现脚本放在 tools/ 下。
  4. 配置侧边栏。 创建或更新报告的 meta.json 和父级 research/meta.json。
  5. 文档检查 + 提交。 在 docs/ 中运行 bun 文档检查流程（build、check:repo-links、tsc --noEmit、test）。提交 docs(research):；推送。

常见错误

  • 强行套用问题 / 原因 / 设计的结构——研究报告形式自由，不是路线图条目。
  • 做出设计决策——这属于 brainstorm。
  • 外部主张缺少来源，或本地数据未注明获取方法。
  • meta.json 中的 pages 与磁盘上的文件不同步。

工具

cargo xtask research scaffold <slug> 会创建目录和 meta.json；cargo xtask research check 会校验 pages 是否与磁盘内容一致。执行通常通过外部命令 /goal Follow <brief> 完成。

评论

支持 Markdown