SuperAPI AI 工具集

jsdocs

写作与研究

查看项目

更新于 10-20 16:21

技能介绍

用途

jsdocs 面向 Effect API 公开文档的编写与审阅工作。当需要撰写或审查 Effect API 的 JSDoc、完善某个模块的文档,或修复文档相关诊断时,可使用该技能。

主要能力

  • 提供文档编写与审查的固定工作流,强调先了解上下文再修改。
  • 支持按需加载参考材料:标签、模块与链接对应 declarations.md;分类对应 categories.md;示例对应 examples.md。
  • 支持对模块进行文档完善,并在存在相近 API 时审计 @see 链接、检查实现与测试以提炼具体的注意事项(Gotchas)。
  • 规定公开声明的文档结构:使用多行块,包含一个自包含的实用描述段落。
  • 对函数和方法要求以现在时动词开头,对值则参考邻近同类名词的表述方式。
  • 可选非空分区按固定顺序出现:When to use、Details、Gotchas,且每个分区只出现一次。
  • 要求描述、分区、示例和标签之间以一个空行分隔。
  • 规定 When to use 需给出与描述不同的正向使用场景;Gotchas 仅用于具体注意事项和失败模式。

使用方式

  1. 检查声明、实现、邻近 JSDoc、测试和调用点。
  2. 在编辑前选择所有适用分支并加载对应参考文档。
  3. 进行聚焦的 API 修复或模块完善,保留已验证事实和有价值的示例,避免机械重写。
  4. 对模块完善或存在相近替代方案的 API,审计 @see 链接,并检查实现和测试以识别具体 Gotchas。
  5. 运行 pnpm jsdocs --check 及所有适用的根验证命令。

适用范围与限制

  • @internal 声明和默认导出不在公开 JSDoc 编写范围内。
  • 被检查文件不支持导出的 enum 或空导出声明。
  • 任务完成的判定标准:每个变更的公开声明满足所有适用参考要求、检查器通过、可运行示例通过其目标 doctest,且其他适用的根检查通过或已报告为未运行。
  • 资料未提供安装命令、收费、价格、平台支持等细节。