SuperAPI AI 工具集

write-docs

办公与效率

查看项目

更新于 10-15 21:55

技能介绍

用途:用于协作式撰写或重写文档,包括提案、技术规格、决策文档、README 章节、ADR 以及需要让陌生读者看懂的长文;也适用于新增用户可见行为后的文档更新、里程碑简报的对外摘要,以及重要变更的 PR 描述。

主要能力:围绕“为全新读者写作”展开——判断标准不是维护者能否看懂,而是没见过代码的人读后能否正确行动。流程分四阶段:一,收集上下文,明确读者是谁(内部工程师、开源贡献者、终端用户等)、读完后应能完成哪一个具体动作、读者已具备哪些知识,并向用户索取缺失材料,不编造示例;二,先迭代结构,产出编号大纲与每节一句话目的,与用户确认后再按序写正文,就地写入目标文件(如 docs/<name>.md、README.md、mintlify-docs/…),不保留草稿,短句优先、具体示例优先,仅在有助于理解时给出小段代码;三,读者测试,像没写过一样从头冷读,检查命名动作是否真的可执行,并大幅删减无关内容,可提议用冷读子代理压测;四,接入,从 README 索引、docs 侧栏等入口链接新文档,决策类文档追加一行到 .gsd/DECISIONS.md,面向公开的变更标记给发布说明或 CHANGELOG。

限制与反模式:正文文档不放文件路径与行号(决策范围的 ADR 可例外),避免“记录我们的过程”的总结式写法,避免重新解释语言或框架等通用概念,禁止跳过冷读。成功标准包括:读者与读后动作被明确写出、大纲先于正文达成一致、有冷读并补齐缺口、主干文档无路径行号、文档从入口可发现、命名动作确实可执行。具体安装命令、收费与平台信息资料未提供。