SuperAPI AI 工具集

doc-validator

通用与其它

查看项目

更新于 10-16 01:15

技能介绍

用途:对 SDD 文档语料库做项目级一致性校验,覆盖文档间关系、累积标签、孤立检测、双向链接一致性、重复 ID、深度可追溯性(可修复)、行文与术语审查,适合发布前或大版本前使用。它是唯一的语料库级校验器,也涵盖此前独立的可追溯性深度与行文审查。不用于单文档结构/元数据/内容检查(用对应层的 doc-<layer>-audit),也不定义 ID 格式规则(规则在 doc-naming,本技能负责执行并报 XDOC-E007)。

主要能力:交叉文档检查含 LINKS、CROSS-REF、ORPHAN、TAGS、IDS、MATRIX、SECTION、DIAGRAM、TERM、COUNT、FWDREF 等类别及对应错误码;SECTION/TERM/COUNT 类通常可自动修复,其余需人工处理。可追溯性深度检查计算双向对称得分(目标≥95%)、覆盖率与孤立项,并在 auto_fix 时仅修复安全项(补反向链接、重生成计数/章节元数据、术语归一),先写带时间戳备份并打印回滚命令,绝不编造占位 ID。行文审查按 DATA、REF、TYPO、TERM 四类检查,strict 下均为错误,permissive 下为警告,并可用项目术语表抑制误报。

使用方式:输入 docs_path(必填)、scope(cross-document 默认/traceability/prose/full)、strictness(strict/permissive)、auto_fix、report_format。校验前读取 .aidoc/profile.yaml,遵循 active_layers(禁用可跳过层时按级联处理,避免误报)与 glossary。质量门禁:ERROR 阻断(exit 2),WARNING 仅在 --strict 下阻断(exit 1),INFO 为提示;项目级要求零交叉引用错误、零孤立、100% 双向与累积标签合规、零重复 ID。输出为 markdown/json/text 合并报告,含发现、代码与修复提示。

限制:框架不含运行时代码,仅对 ${CLAUDE_PLUGIN_ROOT}/framework/governance/ 与各层 README.md 执行声明式检查;结构/内容缺口仍交由对应 -fixer 处理。具体安装与调用命令资料未提供。