What The Diff 使用教程
从入门到精通的完整指南
What The Diff 简介
What The Diff是一款AI驱动的代码差异分析和PR摘要生成工具。它能够自动分析Git代码变更，生成易于理解的变更摘要和说明，帮助团队成员快速了解代码修改内容。支持与GitHub和GitLab集成，在Pull Request中自动生成清晰的变更描述，提升代码审查效率和团队协作体验。
详细功能介绍
【工具简介】What The Diff是一款AI代码变更分析工具，自动为Pull Request生成清晰易懂的变更摘要和说明。
【核心功能】
①AI PR摘要生成：自动分析Pull Request中的代码变更，生成结构化的变更摘要，用自然语言描述修改内容和目的。
②多语言变更解读：支持多种编程语言的代码变更分析，将技术性的diff转化为易于理解的文字说明。
③GitHub/GitLab集成：与主流代码托管平台深度集成，在PR/MR中自动触发分析并添加评论。
④变更影响分析：评估代码变更的影响范围，帮助审查者了解修改可能波及的功能模块。
⑤自定义摘要模板：支持配置摘要生成的格式和内容偏好，适应不同团队的审查流程。
【适用场景】团队代码审查流程中需要快速了解PR变更内容时；大型PR包含大量修改需要AI辅助总结时；非技术成员需要了解代码变更对产品功能的影响时；希望标准化和自动化PR描述格式的开发团队。
【快速入门】
①访问What The Diff官网注册账号。
②将GitHub或GitLab仓库与平台进行关联授权。
③创建或更新Pull Request，工具将自动分析变更并生成摘要。
④在PR评论中查看AI生成的变更摘要和说明。
【优缺点分析】
优点：显著提升代码审查效率，减少阅读diff的时间；自动化的PR摘要生成减轻开发者编写说明的负担；与主流平台集成，无需改变现有工作流。
缺点：对极其复杂的架构变更，摘要可能不够全面；依赖代码托管平台的集成，不支持本地Git仓库；免费版有一定的使用次数限制。
【适合人群】需要高效进行代码审查的开发团队和技术负责人；维护大型开源项目需要清晰PR描述的项目维护者；包含非技术成员的跨职能团队需要了解代码变更时。
1What The Diff 入门教程：AI自动生成代码变更摘要
入门10分钟
What The Diff 是一款AI驱动的代码差异分析和PR摘要生成工具，能自动分析Git代码变更并生成易懂的变更摘要，帮助团队快速了解代码修改内容，提升代码审查效率。
一、快速开始
1. 访问 whatthediff.ai 官网，点击 Sign Up 注册账号。
2. 使用 GitHub 或 GitLab 账号授权登录。
3. 登录后进入 Dashboard，点击 Connect Repository 关联你的代码仓库。
4. 授权完成后，工具会自动监听仓库中的 Pull Request 活动。
二、核心功能演示
功能1：自动生成PR摘要
当团队成员提交 Pull Request 后，What The Diff 会自动分析代码变更内容，在 PR 评论区生成一段结构清晰的变更摘要。摘要会列出新增功能、修改逻辑、删除代码等要点，其他成员无需逐行阅读代码即可快速掌握变更意图。你只需确保仓库已关联，后续 PR 会自动触发摘要生成。
功能2：自定义摘要模板
进入 Settings 页面，找到 Summary Template 选项。你可以自定义摘要的输出格式，例如要求工具按模块分组描述变更、添加影响范围评估、或以非技术人员能理解的语言重写描述。保存模板后，后续生成的摘要将按照你的格式输出。
功能3：变更影响分析
在 PR 摘要中，工具会标注哪些文件或模块受到本次变更的影响。点击摘要中的影响分析部分，可以看到变更涉及的依赖关系和潜在风险点，帮助审查者重点关注可能引发问题的代码区域。
三、实际使用案例
场景1：大型团队协作开发
一个10人开发团队每天产生大量 PR，审查压力大。接入 What The Diff 后，每个 PR 都自动生成摘要，审查者先读摘要快速筛选，将精力集中在高风险变更上，代码审查效率提升约40%。
场景2：跨部门技术沟通
产品经理需要了解本周的开发进展，但看不懂代码。通过 What The Diff 生成的通俗易懂的变更摘要，产品经理可以直接在 PR 中了解每个功能的修改内容，减少沟通成本。
四、常见问题FAQ
Q1：支持哪些代码托管平台？
A：目前支持 GitHub 和 GitLab，企业版还支持 Bitbucket 和自托管 Git 服务。
Q2：生成的摘要准确度如何？
A：对于常规的功能修改和 bug 修复，摘要准确度很高。对于复杂的算法重构，建议结合人工审查。你也可以通过反馈按钮对摘要评分，帮助模型持续改进。
Q3：免费版有什么限制？
A：免费版每月支持50个 PR 的摘要生成，Pro 版无数量限制并支持自定义模板和优先处理。
五、小贴士
1. 保持 PR 粒度适中，单个 PR 变更文件控制在10个以内，生成的摘要质量更高。
2. 善用自定义模板功能，针对不同类型项目（前端/后端/数据）配置不同的摘要风格。
3. 将摘要分享链接直接发给非技术同事，无需对方拥有仓库访问权限即可了解变更内容。