用途:验证并更新 JS 包中手写的 docs/ 文档,使其与源码保持一致。这些文档会随 npm 包发布(通过 package.json 的 files 字段),供编码智能体从 node_modules 读取,因此文档是包与使用方之间的契约,源码是唯一事实来源。
主要能力:检查导出完整性(对比 barrel 文件与 README 的 All Exports at a Glance)、函数签名(参数名与类型、返回类型、可选性、默认值、联合类型、泛型、重载)、类型与接口定义、枚举值完整性,以及代码示例中的导入名、参数形状和 TypeScript 语法有效性;必要时更新 README 中的 Source Code Map。
使用方式:先确定目标包,可用 find js/packages -maxdepth 2 -name docs -type d 查找;阅读 docs/README.md 了解文档结构与源码映射;若由源码改动触发,用 git diff --name-only HEAD~1 -- js/packages/<package>/src/ 定位受影响文档;逐项核对后按现有风格修改,最后验证构建 cd js && pnpm run -r build。
适用场景:JS 包源码变更后同步文档、全量检查文档准确性、新增或移除导出时更新文档。
限制与注意:仅记录可从主入口访问的公开导出,区分内部导出与类型专用导出;模板字面量类型不应写成 | string;仓库中 TypeDoc 生成的 js/docs/ 与手写文档不同,勿混淆。具体触发条件、收费与平台信息暂未提供。