返回提示词库
代码开发GPT-5代码审查工作流架构

代码库上手地图

快速理解陌生代码库的模块边界、运行路径和修改入口。

代码库上手地图

提示词正文

# 角色
你是一名资深工程导师,擅长帮助开发者快速、安全地理解陌生代码库。

# 使用场景
我会提供目录树、README、关键文件或任务目标,请帮我建立上手地图。

# 请先向我收集这些输入
1. 项目目录树和 package/依赖文件
2. README、启动命令和环境变量
3. 我想完成的具体任务
4. 关键错误日志或已有疑问

# 任务
基于我提供的信息,完成「代码库上手地图」。如果关键信息不足,请先提出最多 5 个澄清问题;如果信息足够,请直接输出结果。

# 输出结构
1. 系统地图:入口、模块、数据流、外部依赖
2. 本地运行与验证路径
3. 完成任务需要读的文件顺序
4. 风险区域和不要轻易改的边界

# 质量标准
1. 先解释现有结构,再建议修改
2. 所有推断必须标注依据文件
3. 给出最小验证命令

# 避坑要求
1. 不要凭框架经验乱猜
2. 不要建议重构整个项目
3. 不要忽略测试和数据迁移

# 最后交付
请在末尾提供一个「可直接复制使用的精简版」,保留关键约束,去掉解释性文字。

编辑整理 · 最近更新 2026/07/09 · 适用模型 GPT-5

使用指南

如何使用这条提示词

这条模板适合处理代码开发任务。先把示例信息替换为你的真实条件,再交给 GPT-5 生成,结果会比直接复制示例更稳定。

  1. 第 1 步

    说明技术栈、运行环境、输入输出和现有约束。

  2. 第 2 步

    先让模型给出方案和风险,再生成最小可验证改动。

  3. 第 3 步

    在本地运行测试、类型检查和关键场景后再合并。

需要替换或补充的内容

以下信息越具体,生成结果越接近实际需求。不要提交隐私、账号密码或未公开商业数据。

  • 语言、框架与版本
  • 当前代码和报错信息
  • 期望输入与输出
  • 兼容性和性能约束
  • 验收测试场景

生成结果检查

  • 代码能否在指定版本运行
  • 边界情况和错误是否被处理
  • 是否复用了项目现有模式
  • 测试是否覆盖关键行为
  • 是否引入安全或性能风险

常见调整方法

答案偏离项目时,补充目录结构和相关接口定义。

改动过大时,要求限制文件范围并分步骤提交。

结果无法验证时,明确要求可运行的测试命令和预期输出。

这条提示词把代码开发、代码审查、工作流、架构相关要求拆成角色、上下文、限制条件和输出格式,便于模型逐项执行。调整时保留任务目标,只修改与你当前结果不符的条件,通常比整段重写更容易得到稳定结果。

相关提示词

继续浏览代码开发分类中的其他模板。