SuperAPI AI 工具集

ai-docs

写作与研究

查看项目

更新于 10-16 06:55

技能介绍

用途

ai-docs 是一个面向 effect-ts/effect 仓库的 AI 文档维护技能,主要用于两类场景:编辑 ai-docs/src 目录下的文档源码,以及重新生成 LLMS.md。它把文档的编写、生成与校验串成一条可复用的工作流程,帮助维护者在改动文档时保持源码与生成产物的一致性。

主要能力

  • 依据 ai-docs/README.md 中定义的源码结构、风格、示例、生成方式和 changeset 策略来组织文档改动。
  • 通过参考相邻源码示例和当前相关的 LLMS.md,保持文档风格与内容的一致性。
  • 使用 pnpm ai-docgen 从 ai-docs/src 下的源码重新生成文档。
  • 对生成输出进行审查,关注排序、缺失内容和无关改动。
  • 运行适用的根级校验,确保改动符合仓库要求。

使用方式

  1. 阅读 ai-docs/README.md,了解源码结构、风格、示例、生成与 changeset 策略。
  2. 查看相邻的源码示例以及当前相关的 LLMS.md。
  3. 在 ai-docs/src 下编辑源码。
  4. 运行 pnpm ai-docgen 生成文档。
  5. 检查生成输出,确认排序正确、无缺失内容、无无关改动。
  6. 运行适用的根级校验。

完成标准

任务在满足以下条件时视为完成:源码与生成输出一致;每一处生成差异都能得到解释;当示例或夹具发生变更时 TypeScript 检查通过;适用的检查通过,或被报告为无法运行。

适用场景

适用于需要维护 effect-ts/effect 项目 AI 文档的开发者,尤其是修改 ai-docs/src 源码或需要重新生成 LLMS.md 的场合。

限制

资料未提供该技能的具体安装方式、依赖版本、支持的平台、收费模式或性能指标等信息。