SuperAPI AI 工具集

document-audit-extraction

办公与效率

查看项目

更新于 10-15 09:41

技能介绍

用途

Document Audit & Feature Extraction 是一个用于系统化审计文档集合的技能。它帮助使用者清点、评估并提取文档集合中的结构化数据,从而了解文档库的现状、质量与结构问题。

主要能力

该技能围绕四阶段审计框架展开:

阶段一:清点(Inventory)

回答“存在什么”。通过自动化脚本遍历指定根目录下的文档(默认匹配 .md、.txt、*.yaml),为每个文档生成条目,记录路径、名称、扩展名、字节大小、修改时间、字数以及是否包含 frontmatter。最终可生成清单报告,包含文档总数、带 frontmatter 的数量和总字数。

阶段二:分类(Classification)

回答“每个文档是什么类型”。技能提供文档类型分类表,依据信号将文档归入以下类型:skill(skills/ 目录下带 YAML frontmatter 的文档)、configuration(YAML/JSON schema,如 seed.yaml、registry.json)、guide(含步骤结构的教程)、reference(API 文档、schema 文档)、decision(ADR 格式,含选项与决策)、changelog(按日期排序的条目)、policy(规则与约束)。同时提供自动化分类函数,根据路径和内容特征返回类型。

阶段三:质量评估(Quality Evaluation)

回答“质量如何”。技能提供质量评分卡,按五个维度加权评分:完整性(30%)、准确性(25%)、清晰度(20%)、结构(15%)、维护性(10%)。同时提供自动化质量检查函数,检查项包括:是否有标题、是否有至少两个二级标题、长度是否合理、是否残留 TODO/FIXME、是否有空链接、是否包含代码示例、frontmatter 是否完整,并计算综合得分。

阶段四:特征提取(Feature Extraction)

回答“能提取哪些结构化数据”。技能提供 frontmatter 提取函数和特征提取函数,可抽取标题列表、代码块数量、链接、图片、表格、待办事项等。此外还支持交叉引用映射,构建文档之间的出链和入链图;以及缺口分析,识别缺失的必需文档、推荐文档、孤立文档和空文件。

使用方式

该技能以 Python 代码示例展示各阶段的具体实现,使用者可参考这些函数在自己的文档库上运行审计流程。技能本身未提供安装命令或独立 CLI 工具,具体集成方式暂未提供。

适用场景

适用于需要批量管理文档库、评估文档质量、发现结构性问题(如孤立文档、断链、缺失文档)的场景,例如维护技能库、项目文档、知识库或规范文档集合。

限制与反模式

技能明确列出若干反模式:仅手动审计(应尽可能自动化,人工判断保留给质量评估)、只审计不行动(每个发现应映射到修复动作)、一次性审计(应建立持续监控而非时间点快照)、只计数不评估(文档数量是虚荣指标,质量分数才可行动)、没有基线(审计前应建立质量基准)、忽略交叉引用(孤立文档和断链表明结构问题)。

暂未提供的信息

该技能的收费方式、价格、平台支持、具体安装步骤和独立运行方式在资料中暂未提供。