SuperAPI AI 工具集

indexion-documentation

写作与研究

查看项目

更新于 10-16 07:21

技能介绍

用途:评估文档覆盖情况,检测代码与文档的漂移,并可视化模块依赖关系。属于文档生命周期的评估环节,构建 README 请见 indexion-readme。

主要能力:

  • 覆盖率评估:indexion plan documentation --style=coverage . 报告总体覆盖率、按包拆分及 README 存在情况、函数与类型覆盖率。
  • 详细计划:indexion plan documentation . 生成带优先级与包清单的计划;可用 --format=github-issue 或 --format=json。
  • 未文档化条目:indexion grep --undocumented src/ 列出缺少文档注释的公开声明。检测基于 KGF 分词,识别 pub/public/export 与 fn/struct/enum/type/trait 等声明,并将 /// 注释关联到声明,语言无关。
  • 漂移检测:indexion plan reconcile --format=md . 比较代码符号与文档,报告词汇分歧、陈旧文档、缺失文档。可用 --scope=package-docs、--scope=tree-docs、--doc、--doc-spec 限定范围;时间戳策略可选 --git 或 --mtime-only。缓存位于 .indexion/cache/reconcile/,模式变更或升级后可 rm -rf .indexion/cache/reconcile 清除。
  • 依赖图:indexion doc graph 生成依赖图,默认 Mermaid,支持 --format=dot/d2/text/json,以及 --title、--output。

典型流程:先查覆盖率,再列出未文档化条目,接着做 reconcile,最后生成依赖图并修复后复验。

限制与注意:///| 仅标记也会被计为“已文档化”,覆盖率只测存在而非准确;词汇分歧高常出现在仅自动生成 API 列表的 README;reconcile 只检测实现到文档方向,不检测文档引用了不存在的 CLI 选项;--git 基于提交时间,未提交的修复可能检测不到。其他细节暂未提供。