企业官网建设流程全解析

Repomix 提示词模板实战：用 AI 完成代码审查、文档生成与质量分析

【免费下载链接】repomix📦 Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomix

Repomix 将整个代码仓库打包成单一、AI 友好的文件，让你可以把完整代码库直接喂给 Claude、ChatGPT、Gemini 等大语言模型。本指南基于 Repomix 官方意大利语文档《Esempi di Prompt》整理，提供可直接复制的 9 组提示词模板，覆盖代码审查、文档生成、依赖分析与质量改进四大场景，并补充模型适配建议，帮助你快速上手用 AI 分析整仓库。

前置准备：先生成一份 Repomix 输出

在运行任何提示词之前，先在工作目录生成打包文件：

npx repomix@latest

默认生成 XML 格式的repomix-output.xml，也可以通过--style markdown、--style json、--style plain切换输出格式（详见 输出格式）。生成后，把该文件内容粘贴给 AI 助手（或通过支持附件的模型直接上传文件），即可执行下文所有提示词。

一、代码审查（Code Review）

架构审查

分析此代码库的架构： 1. 评估整体结构和设计模式 2. 识别潜在的架构问题 3. 针对可扩展性提出改进建议 4. 指出遵循最佳实践的方面 重点关注可维护性和模块化。

架构审查适合在项目重构前、新成员介入时使用。Repomix 输出中的directory_structure部分会完整呈现目录层级，文件树生成逻辑 能帮助 AI 快速理解模块边界与依赖方向。

安全审查

对此代码库执行安全审查： 1. 识别潜在的安全漏洞 2. 检查常见的安全反模式 3. 审查错误处理和输入验证 4. 评估依赖安全性 提供具体示例和修复步骤。

需要注意的是，Repomix 本身已集成 Secretlint 安全检查（securityCheck.ts），打包时会自动剔除匹配已知凭据格式的文件；AI 的安全审查侧重于逻辑层漏洞，二者互补。

性能审查

审查此代码库的性能： 1. 识别性能瓶颈 2. 检查资源使用情况 3. 审查算法效率 4. 评估缓存策略 包含具体的优化建议。

二、文档生成（Documentation Generation）

API 文档

生成完整的 API 文档： 1. 列出并描述所有公共端点 2. 记录请求/响应格式 3. 包含使用示例 4. 注明任何限制或约束

开发者指南

创建一份开发者指南，涵盖： 1. 环境搭建说明 2. 项目结构概览 3. 开发工作流 4. 测试方法 5. 常见故障排查步骤

架构文档

记录系统架构： 1. 高层概述 2. 组件间交互 3. 数据流图 4. 设计决策及理由 5. 系统约束与限制

这组提示词之所以有效，是因为 Repomix 输出天然包含全部源码、目录结构和（可选）Git 提交记录——repomix.config.json中的git.includeLogs与git.includeDiffs选项可将提交历史与改动 diff 一并打包，为文档中的"设计决策及理由"提供历史依据。

三、分析与改进（Analysis and Improvement）

依赖分析

分析项目依赖： 1. 识别过期的软件包 2. 检查安全漏洞 3. 建议替代软件包 4. 审查依赖使用模式 包含具体的升级建议。

提示词中"检查安全漏洞"与上文安全审查呼应。Repomix 的 JSON 输出格式尤其适合此类分析：可以用jq直接提取、统计依赖文件，再结合 AI 分析（jq 用法示例见 输出格式文档）。

测试覆盖

审查测试覆盖情况： 1. 识别未测试的组件 2. 建议补充测试用例 3. 审查测试质量 4. 推荐测试策略

代码质量

评估代码质量并提出改进建议： 1. 审查命名约定 2. 检查代码组织 3. 评估错误处理 4. 审查注释实践 提供好模式和问题模式的具体示例。

四、获得更好结果的 4 条建议

无论使用哪组提示词，遵循以下原则都能显著提升 AI 输出质量：

1. 具体化（Be Specific）：包含明确的目标和评估标准，例如"重点关注错误处理"比笼统的"审查代码"有效得多；
2. 设定上下文（Set Context）：说明你的角色和所需专业水平，例如"以资深安全工程师的身份审查"；
3. 要求格式（Request Format）：定义你希望回复如何组织，例如"按严重程度从高到低列出问题，每条附文件路径"；
4. 设定优先级（Prioritize）：指出哪些方面最重要，避免 AI 平均用力。

此外，可以在repomix.config.json中配置output.instructionFilePath指向自定义指令文件（如repomix-instruction.md），将上述上下文、审查目标直接嵌入打包输出，AI 无需在提示词中重复接收（详见 自定义指令）。

五、模型特定注意事项

不同模型对格式与指令位置的偏好不同，Repomix 官方建议如下：

Claude

• 使用XML 输出格式：与 Repomix 默认的 XML 风格天然契合，模型对<file>、<file_summary>等结构化标签的解析准确率更高；
• 将重要指令放在末尾：Claude 对结尾指令的遵循度更好；
• 指定回复结构，例如要求"先给结论，再给证据"。

ChatGPT

• 使用Markdown 格式：可读性最好，便于分节阅读；
• 将大型代码库拆分为多个部分：分块提问，避免上下文过长；
• 包含系统角色提示（system role prompt），如"你是资深后端架构师"。

Gemini

• 兼容所有格式：XML、Markdown、JSON 均可；
• 每次请求聚焦特定领域，例如本次只审查数据库访问层；
• 使用分步分析，要求"先总结，再逐文件分析，最后给出结论"。

六、相关资源

继续深入可阅读以下仓库文档：

• 输出格式：每种输出格式的详细对比与 jq 提取示例
• 自定义指令：向输出中添加上下文与指令
• 使用案例：AI 辅助工作流的真实场景示例
• 代码压缩：针对大型代码库减少 token 数

实践建议：从"架构审查 + 安全审查"两组提示词开始，搭配 Repomix 默认 XML 输出（repomix.config.json 中output.style即为此配置），即可在几分钟内获得一份有完整代码库上下文的 AI 分析结果。

【免费下载链接】repomix📦 Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomix