SuperAPI AI 工具集

assess-docs

写作与研究

查看项目

更新于 10-16 06:50

技能介绍

用途:在单次运行中评估文档核心治理状态,判断文档是否符合规范、证据是否足以支撑规划、缺口如何最小化补齐,产出一份可执行的文档评估报告,供团队明确先修什么、后补什么、由谁处理。主要能力:解析项目规范(优先 .ai-cortex/artifact-norms.yaml,其次 docs/ARTIFACT_NORMS.md,缺失则回退 specs/artifact-contract.md 默认契约);扫描 docs 内容并校验路径、命名、front-matter,形成含位置、类别、严重度、标题、描述、建议的 findings;按层盘点文档覆盖、新鲜度与可用性,标记 strong/weak/missing;计算层级评分与总体 readiness(high/medium/low),标记关键阻断层;按影响与工作量排序缺口,形成最小行动集(顺序、责任建议、目标路径)。使用方式:输入 docs 范围、可选层映射与目标就绪等级(medium|high),运行后写入 docs/calibration/doc-assessment.md,输出含规范合规、分层就绪度评分、最小补全计划三节,并给出核心问题与下一步技能路由建议。适用场景:里程碑前文档就绪检查、规划前证据完整性判断、文档债务清单与优先级梳理。限制:不执行仓库结构写操作,不创建或更新规范文件,不做代码-文档对齐、链接图、SSOT 深度审计;这些分别由 define-docs-norms、assess-docs-code-alignment、assess-docs-links、assess-docs-ssot、tidy-repo 负责。具体命令、价格与平台支持暂未提供。