SuperAPI AI 工具集

ln-53-documentation-auditor

写作与研究

查看项目

更新于 10-16 06:23

技能介绍

用途:以只读方式审计文档体系,评估读者能否找到正确来源、信任其内容并在无隐藏上下文的情况下行动。审计对象包括独立文档与承载公开或运维知识的代码注释。

主要能力:建立文档清单与层级,检查结构、可发现性、覆盖度、一致性与时效性;核对路径、符号、命令、配置键、端口、端点、默认值等事实性声明;用 Git 日志、blame、diff 判断声明变更时间与归属;对每条发现按 P0-P3 分级,并将每个文档面标记为 KEEP、ADD、UPDATE、DELETE 或 MERGE。

使用方式:先确定范围与受众,再依次检查结构与可发现性、相关性与一致性、事实与示例,最后审查注释并输出报告。报告按 Result、Scope、Evidence、Verification、Completion 五段输出,使用用户语言。

限制:不运行发布、迁移、部署、写生产状态或重写文档的命令;生成缓存仅在允许并披露时可用。外部事实须以版本匹配的官方来源为准,否则标记 UNVERIFIED。缺失事实暂未提供。