SuperAPI AI 工具集

check-docs

编程与开发

查看项目

更新于 10-16 03:41

技能介绍

用途:审计项目文档,输出结构化发现报告。它只做调查与报告,不修改文件;如需创建 GitHub issue 可用 /log-doc-issues,修复用 /fix-docs。

主要能力:检查必需文档文件是否存在(README.md、.env.example、ARCHITECTURE.md 或 docs/ARCHITECTURE.md、docs/CODEBASE_MAP.md、CONTRIBUTING.md、docs/adr 或 docs/adrs 目录);评估 README 是否含 Installation、Quick Start/Getting Started、Configuration/Setup 等章节;比对代码中使用的环境变量与 .env.example 的覆盖情况;检测 90 天以上未更新的文档;在认证系统迁移后检查文档中是否残留旧认证引用(如 Clerk、Auth0、Convex Auth、NextAuth、Magic Link、Supabase Auth,以及 RESEND_API_KEY、EMAIL_FROM 等);若安装了 lychee 则做离线链接校验。

输出:按 P0(缺失 README、缺失 .env.example)、P1(README 章节不全、缺架构文档、未记录的环境变量)、P2(文档过时、缺 CONTRIBUTING.md、缺 ADR)、P3(润色与补充)分级的发现,并附汇总统计与建议。

适用场景:项目文档健康检查、开源项目维护、认证系统迁移后的文档一致性排查、Next.js 项目(可核对 App Router 约定、RSC 与客户端组件边界、路由处理器与中间件文档)。

限制:仅审计与报告,不自动修复;链接校验依赖 lychee,未安装时仅提示;部分检查依赖 grep、find、stat 等命令,跨平台行为可能不同;具体安装方式与收费信息暂未提供。