编程开发 通用 中文 English 代码库理解 [规范] 详细理解此仓库。产出一份报告,使新团队成员能够用它浏览代码库… 生成后的提示词 详细理解此仓库。产出一份报告,使新团队成员第一天就能用它浏览代码库。对照代码、锁文件和配置验证一切——不要转述 README。 ## 先定义范围 在阅读代码之前,说明: 1. **你需要理解什么** - 明确重点:整个仓库概览、某个特定子系统、某个特定功能的数据流,或其他内容。如果请求范围很广,选出价值最高的部分并说明。 2. **深度如何** - 快速熟悉(技术栈 + 入口点)还是深入探究(数据流、约定、扩展点)?明确说明深度级别。 3. **什么不在范围内** - 排除与请求无关的任何内容。 在定义范围和深度之前,不要开始阅读。 ## 需要产出什么 1. **它是什么** - 用一两句话说明:项目做什么以及面向谁。用 README 和真实代码确认,而不只是仓库名称。 2. **技术栈,已验证** - 语言、框架、运行时、包/构建工具,以及重要版本。从锁文件、清单文件和配置文件中提取这些信息——不要来自 README 声明或猜测。如果无法确定版本,请说明。 3. **架构,附证据** - 高层形态:代码如何组织(单体、服务、包、monorepo)、入口点(main、CLI、服务器、工作进程、脚本),以及主要部分如何通信。对于每项结构性论断,引用能证明它的文件、目录或函数。 4. **关键数据流** - 沿代码走一两个现实的用户旅程:入口点 → 核心逻辑 → 存储或外部调用 → 响应。为每一跳引用文件:行。如果存在多条路径,选择最具代表性的一条,并注明替代路径。 5. **约定和陷阱** - 新人会踩到的点:不寻常的模式、必需的环境变量、配置文件、构建和测试设置、扩展点,以及已知的特殊行为。区分有文档记录的约定与观察到的行为。 6. **如何运行它** - 安装依赖、运行和测试的准确命令。对照 README、Makefile、scripts/、package.json/pyproject.toml 和 CI 工作流进行验证。如果某条命令无法验证,请说明。 7. **待解决问题** - 列出无法从代码中确认的任何内容,以及什么可以解决它(例如缺失的环境变量、未记录在文档中的脚本、无法读取的依赖版本)。 ## 方法 1. **阅读顶层结构** - 从根目录开始:清单文件、包/依赖配置、构建脚本、CI 工作流,以及任何描述架构的文档。形成初步假设。 2. **形成假设,然后验证** - 对于每项结构性论断(例如“这是一个使用 Node 后端的 React 应用”),找到能证明它的文件或配置。如果某个假设无法确认,将其标记为待解决问题。 3. **追踪真实旅程** - 选择一个用户或系统会走的具象流程,并端到端阅读实际代码路径。为每一步引用文件:行。 4. **检查测试套件** - 阅读项目如何测试自身。测试布局和模式往往比仅阅读源代码更能清楚地揭示约定和架构。 5. **检查 CI 和脚本** - 阅读工作流和辅助脚本,以了解项目如何构建、测试和部署。这些内容常常会暴露仅靠源代码无法看到的需求和陷阱。 6. **带引用总结** - 产出上述报告,并为每项结构性论断提供文件:行引用。没有证据就不要下论断。 ## 验证 在报告理解完成之前,确认以下每一项: - [ ] 每项结构性论断(技术栈、架构、入口点)都有文件、配置或函数引用作为依据。 - [ ] 版本和依赖是从锁文件或清单文件读取的,而不是从 README 推断的。 - [ ] 至少有一条真实数据流被端到端追踪,并带有文件:行引用。 - [ ] 运行命令已对照项目的实际工具(README、Makefile、scripts/、CI、清单文件)验证,而不是凭空编造。 - [ ] 任何无法确认的内容都列为待解决问题,而不是陈述为事实。 - [ ] 报告区分了有文档记录的约定与观察到的行为。 ## 规则 - 阅读代码。对于每项结构性论断,指出能证明它的文件或函数。 - 如果 README 错误或过时,请说明,并以代码为准。 - 简洁具体。不要用“这个项目采用了现代最佳实践”之类的空话。 - 在阅读前说明范围和深度。除非请求很小,否则不要试图一次完成整个仓库加深入探究。 - 如果某些内容无法从仓库中确定,请说明缺少什么以及如何找到它——不要猜测。 复制提示词 分享提示词 查看示例 发送到 AI 优化器 收藏模板 保存当前版本 示例 关闭 分享 卡片风格 雾面玻璃 暖白纸笺 深夜蓝图 薄荷网格 珊瑚日落 水墨笺 关闭 图片仅展示节选。