SuperAPI AI 工具集

docs-sync

写作与研究

查看项目

更新于 10-16 07:27

技能介绍

用途:在修改 ioredis 代码后,判断该改动是否需要文档更新,并更新正确的文档位置,使示例与经过测试的行为保持一致。若进行大范围文档审计、选项/API 覆盖检查或文档范围不明确,应先阅读 references/doc-coverage-checklist.md。

主要能力与工作流:

  1. 检查改动行为:阅读 diff 及周边实现,判断用户是否需要了解新能力、选项、错误情况、事件、命令签名、返回结构或迁移注意事项;当命令签名、构造函数选项或导出类型变化时,将 TypeScript 声明和公共 JSDoc 视为文档。
  2. 定位文档面:README.md(用户指南、示例、功能概览、选项、常见工作流)、lib/redis/RedisOptions.ts、lib/cluster/ClusterOptions.ts、lib/connectors/StandaloneConnector.ts 与 lib/connectors/SentinelConnector/types.ts、docs/(TypeDoc 生成输出)、examples/、lib/index.ts 及公共 TypeDoc 注释、test/typing/。
  3. 按改动类型更新:公共选项或构造函数行为先在 JSDoc 中记录名称、默认值、行为、拓扑限制和 Redis 版本约束,必要时更新 README/示例;Redis 命令支持需更新 bin/ 中的生成器配置并重新生成 lib/utils/RedisCommander.ts;Pub/Sub、分片 Pub/Sub、monitor、pipeline、事务、Sentinel、Cluster、TLS、重连或离线队列行为更新对应 README/docs 章节;lib/index.ts 的公共导出变化更新 TypeDoc 注释和类型测试;破坏性或兼容性敏感行为添加迁移或注意事项;纯内部重构说明无需更新文档及原因。
  4. 保持示例真实:优先使用能针对当前公共 API 编译的简短示例;不记录未被测试覆盖的行为,除非同时补充或请求覆盖;示例若依赖 Redis 版本、拓扑或协议模式需就近说明;沿用现有 README 风格与术语。
  5. 验证:TypeScript 示例或声明运行聚焦的 tsd 测试;API 文档注释变化运行 npm run docs;命令类型变化先运行 node bin/index.js 再验证生成类型;仅 Markdown 编辑检查附近格式与链接,相关文件被 Prettier 覆盖时运行 npm run format-check。

文档决策清单:改动是否影响 lib/index.ts 公共导出;是否增删改 RedisOptions、CommonRedisOptions、ClusterOptions、独立连接选项或 Sentinel 连接选项的 JSDoc/默认值;是否增删改 Redis 命令方法签名;是否改变回复转换、Buffer 变体、回调或 Promise 行为;是否影响连接生命周期、重试、就绪检查、离线队列或订阅者模式;是否影响 Cluster 路由、重定向、订阅者组、Sentinel 发现或 TLS;是否新增选项、事件、错误条件或环境假设;用户是否需要修改代码。任一为是则更新文档,或明确说明现有文档已覆盖。

限制:资料未提供该技能的安装方式、收费、价格、平台或效果信息。