SuperAPI AI 工具集

write-for-ai

写作与研究

查看项目

更新于 10-16 09:53

技能介绍

write-for-ai 是一套针对“面向 AI 读者”的文档写作技能。它主张文档的首要读者是未来的 AI 助手:同一操作者、同一模型,但没有任何本轮对话上下文。因此输出风格要求 AI 易读——表格优于散文,显式文件路径优于模糊引用,明确声明“总是做 X、绝不 Y”,并保证每次会话重读同一文件时收益可观。人类读者也能受益于这种结构。

用途与产物:生成 README、CLAUDE.md/AGENTS.md、提交信息、PR 描述、CHANGELOG、架构文档等。

主要规则与能力:

  • 动手前先写 Assumptions 块,列明目标产物、受众(默认 AI 为主、人类为辅)、编辑模式、可验证声明;假设错误或含糊时必须停下追问,禁止静默选择解释。
  • 固定文档结构:Header、Orientation、Repo map、Invariants、How-to、Architecture、Change log、Conventions、Pointers,不同文档类型取子集。
  • 脱敏规则表:文件路径用仓库相对路径,禁止绝对路径(含用户名);不得写真实令牌、密码、密钥、真实 PII、生产数据库主机名、内部 IP 等;不确定时使用占位符并提示操作者替换。
  • 客观性要求:不用无依据的营销形容词与最高级,不用营销比喻,也不使用含糊对冲词;能力声明旁边必须放可复现的验证命令;数字要具体或省略;状态标记(early/stable/deprecated 等)写入头部;禁止自我夸赞。
  • 输出前自审清单:仓库特定而非通用、无编造事实、无泄露面、公开措辞正常、验证声明真实、语气客观,六项任一不通过须先修正。
  • 输出原则:表格与清单优先;路径一律仓库相对并用反引号包裹;声明式语气;不变式与历史分离;验证命令紧跟其声明;设“最近决定”区块避免重复争论;反装饰;宁短勿全。

限制与边界:作者明确将其定位为面向 AI 读者的文档风格技能,人类可读性为次要收益;若操作者要求营销文案、最高级或无依据声明,技能会依据客观性条款拒绝并说明原因;缺少对应验证命令时应询问删除声明还是补充验证。适用于需要让未来 AI 会话冷启动理解代码库、维护项目不变式与约定的开发场景。资料未提供具体安装、运行命令与支持平台信息,暂未提供。