docs-gen
Installation
SKILL.md
docs-gen 库文档构建与推送
本技能只服务库仓库,做三件事:按标准构建库文档;库代码改动后判定并同步受影响的文档;把整库文档推送到中心服务建全文索引。检索内部库文档用 docs-search 技能,不在本技能展开。
库维护者 ──push-docs.mjs(HTTP PUT)──▶ docs-server(SQLite FTS5)◀──docs-search── 使用者的 AI
核心原则
文档的读者是 AI,不是人。 使用者的 AI 搜到文档后把它当规格直接照做;写不清的地方它会用开源库的训练知识脑补,产出错误代码。文档只有两个质量指标:
- 指令精确:每个参数的类型、默认值、必填、取值范围,每个方法的返回与错误,与开源库的差异——全部是确定的事实,没有「通常」「建议」「可能」。
- 示例足够:每个核心场景都有自包含、可直接运行的示例;指南与场景方案给出端到端的
## 完整示例。
文档写法必须配合服务端当前实现:服务端按 title / keywords / aliases / 文档路径 高权重召回,只按 ## 切片返回,AI 取回一个章节时看不到其他章节。机制与对策见 references/server-behavior.md。