检测知识库中的坏链、缺失前置数据、标签不一致及覆盖盲区。当用户说“审计知识库”、“检查前置数据”时调用。

安装

概览

Audit 是一个专为知识库质量检查设计的自动化工具,旨在识别并报告 Markdown 格式文档中的各类问题。它通过系统化的扫描流程,帮助维护者快速发现知识库中存在的结构性缺陷和潜在风险点。该工具能够自动检测缺失的前置数据(frontmatter)、损坏的内部链接、标签命名不一致、孤立文件以及内容覆盖盲区等常见问题。无论你的知识库规模大小,只要是以 Markdown 为主要载体的项目,都可以通过 Audit 获得全面的质量评估报告。其核心优势在于无需人工逐项排查,即可生成结构清晰的问题清单和改进建议,极大提升了知识库维护的效率与规范性。

核心功能特点

  1. 自动检测 Markdown 文件中缺失或不完整的 YAML 前置数据(frontmatter),包括必填字段缺失和格式错误
  2. 识别并列出所有损坏的内部链接,确保知识库内引用关系完整可靠
  3. 分析标签使用一致性,标记重复或拼写相近但含义相同的标签,避免分类混乱
  4. 找出未被任何其他文档引用的孤立文件(orphaned files),防止重要内容被遗漏
  5. 评估内容质量,如长期未更新的草稿文档、信息量过少的内容或关键元数据缺失的情况
  6. 检查目录覆盖率,提示空目录或文件数量过少的区域,辅助优化知识结构布局

适用场景

Audit 工具特别适用于需要定期维护和优化的大型知识库环境。例如,在团队协作编写技术文档时,成员可能各自添加新文件并使用不同的标签习惯,导致后期难以统一检索和管理。此时运行 Audit 可快速定位标签冲突和孤立文档,推动团队建立一致的命名规范。对于个人知识管理系统,尤其是采用 Obsidian 或 Notion 类工具构建的笔记体系,随着文件数量增长,手动检查链接有效性变得繁琐。Audit 能自动验证所有内部链接是否指向真实存在的文件,显著降低维护成本。此外,当知识库经历重大结构调整或迁移后,使用 Audit 进行全面扫描有助于发现因路径变更导致的断链问题,并识别出因缺乏交叉引用而可能被遗忘的重要资料。无论是初创阶段的小型知识库还是成熟企业级的知识资产平台,Audit 都能提供持续的质量监控能力,保障知识体系的健壮性和可用性。