SuperAPI AI 工具集

docs

写作与研究

查看项目

更新于 10-16 05:29

技能介绍

用途

docs 是一个文档健康检查、验证与维护技能,面向所有 ideas 项目,用于定期维护、发现文档缺口并保持文档准确。

主要能力

该技能提供以下命令:

  • /docs --health:生成整体健康报告,包含评分。
  • /docs --validate:检查断链、缺失文件。
  • /docs --stale:查找超过 30 天的文档。
  • /docs --sync:将 CLAUDE.md 与项目状态同步。
  • /docs --project coordinatr:聚焦特定项目。

各标志用途:

  • --health:带评分的综合健康报告。
  • --validate:检查链接、引用、必需文件。
  • --stale:查找过时文档。
  • --sync:用当前状态更新 CLAUDE.md。
  • --project:聚焦特定项目。

报告内容

健康报告示例包含整体评分(如 72/100)、按项目分列(Brief、Critique、Specs、Issues、Score)以及建议(如对某项目运行 /critique、为某项目创建 project-brief.md)。

验证报告示例包含:断链(如 ideas/coordinatr/README.md:15 指向 ../specs/SPEC-001.md 未找到)、缺失必需文件(如 ideas/irl-social/project-brief.md)、孤立文件(如 ideas/shared/docs/old-research.md 未被引用)、结构问题(如 ideas/lorecraft/ 缺少 issues/ 目录)。

健康评分权重:README.md 20%、project-brief.md 25%、critique.md 15%、specs/ 20%、issues/ 10%、Freshness 10%。

执行流程

  • --health:扫描所有 ideas/*/ 目录;检查必需文件;统计 specs、issues、研究文档数量;计算每个项目的健康评分。
  • --validate:解析 markdown 文件中的链接;验证链接目标存在;检查必需结构;识别孤立文件。
  • --stale:通过 git 获取文件修改日期;标记超过阈值的文件;按严重程度分类。
  • --sync:读取当前 CLAUDE.md;扫描所有 ideas/*/README.md 获取状态;比较并识别差异;提出更新建议。

适用场景

  • 每周文档审查
  • 展示想法之前
  • 添加/移除想法之后
  • 查找被遗忘的项目

限制

资料中未提供关于收费、价格、平台支持范围或具体效果保证的信息。