SuperAPI AI 工具集

shipping-artifacts

写作与研究

查看项目

更新于 10-16 03:41

技能介绍

用途:AI 代理写代码很快,却不留下意图记录——系统该做什么、谁被允许做什么、密钥在哪、哪些规则真正被验证。缺少这些记录,人类和审计代理都无法判断代码能否安全发布。本技能定义了一小套恢复可审查性的文档,面向两类读者:人类审查者和下一个 AI 编码代理,也是后续安全或性能审计的“意图基准”。

主要能力:核心文档每个可审查应用都要产出——architecture.md(系统概览、技术栈、认证/会话/声明流、信任边界、已知风险、相关文档索引)、flows.md(承载权限与副作用的流程,含各受保护步骤的授权检查与信任边界穿越)、permissions.md(角色/声明、资源×操作×角色矩阵、行级安全)、variables.md(配置与密钥表、客户端无密钥确认、上线前清单)、tests.md(验证映射:现有覆盖、建议测试、缺口三段)。条件文档仅在能力存在时添加:emails.md、cron.md、seo.md、automation.md;不存在时在 architecture.md 写一行说明,而非编造空文档。

使用方式:多数文档由 /document-app 从代码反向工程得出;tests.md 例外,由 /derive-tests 从其他文档派生。仓库自身设置优先:先查 AGENTS.md、CLAUDE.md 及既有 docs 目录、等价文档、覆盖映射、报告位置,遵循其命名与日期约定;仅在仓库无约定时用插件默认(documentation/ 目录、documentation/tests.md、reports/<name>_{timestamp}.md,不写更新日期行)。输出需说明每个写入位置遵循仓库设置还是插件默认。禁止创建仅大小写不同的文件名,创建前做大小写不敏感检查。

适用场景:AI 生成应用发布前的可审查性整理、安全与性能审计的意图对照、权限与密钥风险梳理、测试覆盖缺口识别。

限制:文档须如实反映当前状态,是准确地图而非健康证明;flows.md 不收录不涉及权限、数据完整性、外部副作用、金钱、隐私或运营安全的流程;示例与成品模板不写入文档;AGENTS.md/CLAUDE.md 属另一产物,由 /ship-check 在交接步骤生成,不在此处。资料未提供具体收费、价格或平台信息。