plain-docs

把任何技术项目写成外行 10 分钟能读懂的文档。

不是"简化版说明书"，是翻译：类比先行、黑话解码、诚实边界。

给任何 agent 发这个仓库链接 + 一句指令，它就能照 SOP 产出文档——不绑定特定工具。

用法（就一步）

把 SKILL.md 的链接发给任何 agent，说：

按 https://raw.githubusercontent.com/Oliver-onea/plain-docs/main/SKILL.md 的 SOP，给这个项目写一套通俗文档

完事。agent 会读仓库、按六步 SOP 产出三件套到 docs/。

产出什么

文件	角色
PROJECT_GUIDE.md	人话导读（入口）：一句话心智模型 + 职业类比 + 黑话解码表
PROJECT_DIAGRAM.md	图示版：架构图的逐行人话翻译
PROJECT_ONE_PAGER.md	一页纸密度版：每个数字可溯源

SOP 六步

1. 一句话心智模型——「它是一个 ___ 的 ___」，必须带项目的执着点。写不出来说明还没懂，回去重读代码
2. 职业类比通篇——一个职业的完整工作流映射所有模块，禁止比喻混用
3. 黑话解码表——每条人话独立成立、不丢关键语义
4. 图逐行翻译——架构图每个框每条边配人话对照
5. 诚实能/不能清单——每条「能」有实测实证；「不能」区分边界（不做）和还没做
6. 去哪下一步——导读是入口不是终点

实战样例

一个 4.8 万行的分布式爬虫仓库，被翻译成"特别守规矩的图书采购员"—— 六步每步的真实产出见 references/example.md。

License

MIT