SuperAPI AI 工具集

living-artifacts

写作与研究

查看项目

更新于 10-15 17:19

技能介绍

用途:适用于为他人或未来的自己编写任何 Markdown 文档,如 README、分析文档、状态报告等。核心要求是:每个静态状态快照都必须与可重新生成它的命令、查询或脚本配对。

什么算快照:写作与阅读之间可能发生漂移的内容,包括文件树与目录列表、端口号/主机名/URL/路径、版本号/部署 commit/镜像 tag、行数/表内容/API 响应体、用户或仓库或服务列表、当前失败的测试等状态快照、别处已有权威归属的配置值、计数与聚合值。

模式:对每个快照,就近给出三样东西——先写复现器(生成该值的确切命令、查询或脚本);再写快照,并明确标注这是“写作时”的视图而非永恒事实;最后加一句漂移提示,说明该值可能已变化,可用复现器刷新。

单一事实来源:当某值已有权威归属时,应引用来源而不是在文档中重复它。例如不要在文档中硬编码端口,改为引用定义它的环境变量或配置;不要在 README 里手动列名字,改为指向目录或生成的列表;不要硬编码 git SHA,改为在阅读时解析 SHA 的命令;不要把 API 字段表复制进文档,改为内省实时 API 的命令。

文件引用必须可点击:Markdown 中提到具体文件路径时,用 Markdown 链接包裹,便于跳转,坏链也能快速暴露漂移。适用于源文件、配置文件、同级文档、脚本、技能文件和读者应检查的生成产物。使用相对 Markdown 文件位置的相对路径;不要链接占位符、通配符或代码块中类路径的 CLI 片段。

事实与假设:事实当前可验证,应带复现器;假设当前不可验证,必须显式标注。把实测事实与解读分开。

读者定位:安装 README 面向最终用户,贡献者文档和 AGENTS.md 面向维护者,细节放对位置。

发布前自查:每个具体值三个月后是否仍正确?若否,复现器是否就在旁边?读者运行复现器能否得到相同值?若不能,文档不完整。

限制:资料未提供该规范的工具支持、自动校验方式、收费或价格信息。