SuperAPI AI 工具集

write-docs

通用与其它

查看项目

更新于 10-15 21:36

技能介绍

用途:write-docs 用于撰写和编辑项目文档(README/markdown),核心理念是把文档当作“术语表”——命名各个组成部分、说明其存在原因,并承载读者无法通过检索代码得出的原则。代码是当前事实的唯一来源,文档不应与之竞争。写作前先问:读者读代码是否更快更可靠?若是,就指向代码而非复制。

主要能力:区分“保留”与“舍弃”。保留读者无法检索到的内容:WHY(某物为何存在、拆分背后的原则、文件名未揭示的分类);非显而易见的发现(平台怪癖、“删掉这个会导致 X 因 Y 而坏”、两个文件默默共享的契约);指向内容所在位置及其类型与归属规则。舍弃代码或 git 历史已包含的内容:精确清单(场景名、场景表、辅助列表、类 id、文件列表、命令/标志矩阵)、叙述与变更日志、精确计数与当前常量等只是复述代码的内容。

使用方式:以“指向而非转录”为原则,在想要罗列细节处,改为命名拥有它们的文件夹或单一文件并引导读者前往,优先文件夹而非文件、优先事实来源注册表而非转录副本。每个事实只有一个规范归属,其他文档链接到它;文档构成从根/枢纽文档可达的树,导航向下流动,仅在复用已有事实时才向上或横向链接,避免无信息的“属于 X”回链。

编辑既有文档时,见到代码可发现项的枚举、变更日志与叙述、复述代码的句子即删除;然后以毫无对话背景的陌生人视角重读,每行都应是原则、缘由或指针。若某行改成链接同样真实有用,就改成链接。

适用场景:创建或修订 README、整理项目文档结构、精简冗余文档。限制:资料未提供具体安装命令、平台支持、收费或价格信息。