工具与工作流工具 / 工作流

38.零基础编程实战:文档一致性审查/cmd-doc-review-code

description: | 审核代码实现与文档说明的一致性。 触发时机:发布前检查、文档更新验证、API 变更后、用户要求审核文档与代码一致性时使用。 输出要求:至少 30 个问题项。 不适用于:纯代码审查(无文档变更)、新项目初始化、草稿文档。

PREVIEW

文档一致性审查

试读预览

- 项目上下文:当前正在审阅的仓库本身 - 代码结构:以仓库实际目录结构为准 - 文档位置(重点扫描范围): - README:仓库根目录下的说明文件 - 其他文档:docs/ 目录及其子目录下的所有文档 - 合同/类型定义(如有): - 共享 contracts 目录、OpenAPI 描述文件、proto 定义、GraphQL schema、TypeScript 类型定义等 对比 README + docs/ 与 代码/配置/合同文件,系统性找出所有「已过时」或「与实现不一致」的描述: - 功能与特性(Features、支持的格式/协议/平台) - 对外接口(API/RPC/HTTP/CLI…

解锁完整正文¥499

本篇属于付费课堂「AI 编程工作台」。解锁后在同一链接开放全文、配套与鉴权下载。

解锁「AI 编程工作台」 ↗已购买?登录后查看 →
STRUCTURED NEXT STEP

继续进入结构化课程或精选资产