| name | mj-book-research |
| description | Use when preparing a technical book, orange-book, or long-form guide and the draft must be grounded in official documentation, release notes, and a saved evidence ledger before writing starts. |
MJ Book Research
为长篇技术写作做“可落盘、可追溯、可扩写”的研究。
什么时候用
- 写白皮书、橙皮书、完整教程
- 主题跨度大,不能靠记忆写
- 需要区分官方事实、作者判断、社区经验
- 后续还会继续扩章节,不希望每次都重新调研
工作流
1. 先建研究文件
在 research/ 下先创建主题文件,再开始搜索。
建议命名:
research/<topic>-official-research-YYYY-MM-DD.md
research/<topic>-source-map-YYYY-MM-DD.md
2. 先收“能当锚点”的来源
优先级固定:
- 官方文档
- 官方 changelog / 官方博客 / 官方 solution brief
- 官方 GitHub 仓库
- 官方合作伙伴材料
- 社区讨论或开源工具
对于 Cloudflare,优先使用:
https://developers.cloudflare.com/<product>/index.md
https://developers.cloudflare.com/<product>/llms.txt
https://developers.cloudflare.com/<product>/llms-full.txt
Cloudflare 文档已经明确提示 AI agent 不要优先吞 HTML。
3. 每条信息都落成“证据账本”
至少记录这 6 列:
| Claim | Source | Date | Tier | Confidence | Planned use |
|---|
| 这条事实是什么 | 链接 | 获取日期 | 官方/社区 | 高/中/低 | 用在哪一章 |
4. 把写作线索和事实线索分开
研究笔记里至少有两层内容:
- 事实层:能引用、能交叉验证的事实
- 叙事层:这条事实为什么对读者重要,适合放在书的哪一段
5. 中国章节单独处理
凡是涉及中国网络环境,必须分成三类,不要混写:
尤其要把“官方 China Network”和“社区优选节点/优选 IP”分开。
输出标准
一份合格的 research note,至少包含:
- 调研目标
- 关键问题
- 已确认事实
- 仍待确认的问题
- 来源列表
- 章节映射建议
失败信号
- 写了很多字,但没有来源链接
- 只记了结论,没有记原始出处
- 把社区经验写成官方承诺
- 中国场景只谈“体感”,不谈 ICP、产品可用性和合作方边界