Mj Orange Book Writer

Use when writing a technical orange-book or handbook that should read like a product manual with explicit judgment, dense tables, and stable chapter structure rather than a polished blog post.

makerjackie Updated

File contents

MJ Orange Book Writer

这不是营销写作,也不是个人散文。

它的目标更接近 openclaw-orange-book:把复杂产品写成一套稳定的技术手册。读者翻开任意一章,都应该能迅速看到判断、表格、边界、建议,而不是先看三段铺垫。

总原则

  • 先给判断,再给解释。
  • 先给表格,再给展开。
  • 先写“什么时候别用”,再写“它有多强”。
  • 产品之间要写关系,不要写成孤立目录。

一章的标准章法

  1. 用 2 到 4 句写清这章的主判断。
  2. 在前 1/3 放一张主表。
  3. 用 2 到 4 个小节解释机制、场景、边界和误区。
  4. 核心建议 收口。

主表优先级

如果一章只允许一张表,优先写下面这些:

  • 产品定位表
  • 适合 / 不适合表
  • 和相邻产品的对比表
  • 计划限制或中国可用性表

必写内容

每一章至少覆盖下面四项里的三项:

  • 解决什么问题
  • 什么时候该用
  • 什么时候别用
  • 和谁最容易混淆

不能这样写

  • 不能从“X 是一个……”一路写成文档导语
  • 不能只写优点,不写误用成本
  • 不能为了显得自然,把判断写得过于模糊
  • 不能把官方 marketing 句式直接翻成中文

Cloudflare 专项要求

产品关系要写透

这本书真正要解决的不是“Cloudflare 有什么”,而是:

  • 先学哪个
  • 谁依赖谁
  • 哪些产品看起来接近,但适用场景完全不同

中国章节必须拆线

永远分成三条线:

  1. 默认全球网络路径
  2. 官方 China Network
  3. 社区优选 IP / 优选节点

容易变的数字要慎写

价格、限额、地区支持范围都可能变化。写法优先级是:

  1. 先写决策逻辑
  2. 再写官方当下边界
  3. 最后才写具体数字

交付标准

  • 任意一章都能被扫读
  • 表格能独立传达信息
  • 作者判断足够明确
  • 读起来像产品手册,不像 AI 总结

makerjackie/cloudflare-orange-book/tree/main/mj-skills/mj-orange-book-writer commit 098f46b11d

Frequently asked questions

npx skillmds@latest add makerjackie/mj-orange-book-writer