SuperAPI AI 工具集

validate-document-artifacts

办公与效率

查看项目

更新于 10-16 01:35

技能介绍

用途:检查 docs/ 下的文档是否符合项目工件规范(或默认 spec/artifact-contract.md),输出 findings 列表,帮助用户修复路径、命名、front-matter 违规。

主要能力:解析项目规范(.ai-cortex/artifact-norms.yaml 或 docs/ARTIFACT_NORMS.md,回退 spec/artifact-contract.md);枚举 docs/ 下 Markdown;按路径模式或 front-matter 的 artifact_type 推断工件类型;对照规范校验路径、命名和 front-matter;每条违规输出 Location、Category、Severity、Title、Description、Suggestion。

使用方式:输入项目路径(默认工作区根),可选指定 docs 根(默认 docs/)与范围(all 或特定 artifact_type)。执行分三阶段:解析规范、扫描推断、校验输出,最后给出扫描文件数与按严重度统计。

适用场景:提交前检查、已有文档审计、规范更新后重新校验。

限制:只读,不修改文件;不自动修复(由用户应用建议);不建立规范(应使用 discover-document-norms);不评估文档就绪度(应使用 assess-documentation-readiness)。缺失信息暂未提供。