SuperAPI AI 工具集

doc-health-audit

测试与质量

查看项目

更新于 10-16 06:51

技能介绍

用途:对文档集做全面健康审计,覆盖结构健康、语义准确性、主题完整性、文风质量和信息架构五个维度。它本身不重复各阶段逻辑,只定义运行顺序、阶段门控和合并摘要,每个阶段委托给对应专用技能。

主要能力:五阶段流水线为——阶段1结构→doc-maintenance;阶段2准确性→doc-claim-validator;阶段3完整性→doc-completeness-audit;阶段4质量→doc-quality-review;阶段5架构→doc-architecture-review。顺序有依赖:结构是基础,先发现断链和孤立页;准确性依赖结构;完整性依赖准确性;质量与架构依赖完整性。

使用方式:先确定范围(全量 docs/、site/、README.md;指定目录;或用 git diff --name-only main...HEAD -- '*.md' 只看改动)。然后按序运行各阶段并检查门控:结构阶段若断链超过10条则警告用户,若存在缺失索引页或导航完全损坏等严重问题则建议停止;准确性阶段若出现 P0 问题则警告;完整性与质量阶段无门控,始终继续;架构阶段需传入阶段3的缺口清单。最后合并为统一摘要,含仪表盘(各阶段状态、关键指标、首要发现)、整体健康度、跨阶段前5项优先行动和各阶段完整报告。

适用场景:发布前审计、月度或季度定期检查、大规模重构后、文档质量未知或不可信时、首次评估文档集。也支持部分运行,如只查准确性跑1+2,只查缺失跑1+3,只查文风跑4,只查可发现性跑1+5,快速发布前检查跑1+2+3。

限制:不要只查一个维度却跑全部五阶段,应直接用对应单项技能;不要跳过阶段1;不要忽略门控警告;不要在同一会话中把审计与修复混做;不要对归档文档(docs/archive/)运行。具体安装命令、收费与平台信息暂未提供。