工程开发
doc-audit avatar

doc-audit

审核 Packmind 文档,将 MDX 文件与代码库交叉比对,以检测无效链接、过时的 CLI 参考及文件缺漏。

简介

doc-audit 是一项先进的维护工具,专为使用 Packmind 来管理架构标准与工程规范的软件工程团队所设计。它确保位于 apps/doc/ 的终端用户文档能与不断演进的代码库保持同步。通过执行多阶段的结构分析,此技能能识别文档中的技术债,特别是针对代码更新速度超过手动内容更新时所产生的问题。本工具适用于技术主管、文档维护人员及开发者体验工程师,他们需要在项目发布前或作为定期健康检查的一部分,确保文档的高质量与可靠性。

  • 从 docs.json、CLI 指令定义与包目录中自动提取基准数据。

  • 通过并行探索代理程序审核各文档章节,包括入门指南、概念、工具、集成、治理与管理。

  • 检测损坏的内部 MDX 链接、过时的 CLI 指令参考、不存在的架构概念以及误导性的技术信息。

  • 借由比对实际源代码领域与 CLI 指令与已记录页面,识别文档缺漏情形。

  • 生成包含错误严重性等级(ERROR、WARNING、INFO)的结构化 Markdown 报告 (doc-audit-report.md)。

  • 通过去重与严重性排序,协助用户优先处理关键的文档错误。

  • 本技能仅负责检测,不会直接修改 MDX 文件,确保审核过程非破坏性。

  • 请确保存储库结构符合预期的 apps/doc/ 与 apps/cli/src/infra/ 路径,以利精确交叉比对。

  • 适用于 CI/CD 流水线触发、版本发布就绪检查以及重构后的文档维护。

  • 产出的报告包含摘要表格与详细发现,非常适合作为整合至 Pull Request 评论或自动化状态检查的依据。

  • 基准数据阶段作为防护措施,确保审核永远是针对应用程序源代码的最新状态进行,而非过时的缓存版本。

仓库统计

Star 数
275
Fork 数
13
Open Issue 数
50
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 02:22
在 GitHub 查看