让AI写出人类和机器都能读懂的文档——HADS文档标准上手体验
让AI写出人类和机器都能读懂的文档
你有没有这种感觉:让Claude写一份技术文档,它洋洋洒洒几千字,但你让另一个AI去读,出来的理解完全跑偏?问题不在AI,在于文档格式根本没有结构——人类看得懂,AI看了个寂寞。
今天想安利一个解决这个问题的Skill,叫HADS(Human-AI Document Standard)。它本质上是一套文档写法规范,核心思想很简单:给文档内容打标签,告诉AI哪些要细读、哪些可以跳过、哪些是已知bug。
HADS定义了四种块:
- [SPEC]:权威事实,必须精确。AI永远读取。
- [NOTE]:人类上下文,比如背景、例子。AI可以跳过。
- [BUG]:已知故障,带症状+原因+修复方案。AI必须读。
- [?]:未经验证的推测,置信度低,要标注不确定性。
写文档时,先在头部声明版本和AI阅读指南,然后按结构填内容。AI读到HADS文档,会先找AI manifest(阅读指南),然后按优先级读取对应块——这样它不会把背景故事当技术细节,也不会把推测当事实。
这个Skill实测过:同样一份文档,用HADS格式重写后,AI的事实准确率提升明显。Token消耗还更少,因为AI不需要全文扫描才能理解文档结构。
安装方式超简单:
- Claude Code用户:
/plugin marketplace add wshobson/agents然后/plugin install documentation-standards@wshobson/agents - 直接安装HADS skill:
npx skills add wshobson/agents --skill hads
适合谁用?需要写技术文档、API文档、交接文档的开发者,或者让AI帮你写文档后还要AI自己执行操作的场景。MIT协议,免费开源。
GitHub仓库(含完整SKILL.md和文档标准说明)
评论区
0 条评论
登录后可评论。