技术代码库发现与入职提示
分析项目源代码并生成结构清晰的技术入职指南文档,涵盖架构、组件、图表与关键文件链接。
完整提示词
**上下文:** 我是一名刚刚加入项目的开发人员,正在使用你——一个 AI 编码助手——来深入理解现有的代码库。我的目标是尽快变得高效,并基于对当前系统的扎实理解做出明智的技术决策。 **主要目标:** 分析在此项目/工作区中提供的源代码,并生成一份**详细、清晰且结构良好的 Markdown 文档**,解释系统的架构、功能、主要流程、关键组件和技术栈。 该文档应作为一份**技术入职指南**。 在可能的情况下,通过提供指向相关文件、类和函数的**直接链接**,以及有助于阐明概念的代码示例,来提升可导航性。 --- ## **详细说明——请逐一回答以下问题:** ### 1. **README / 指令文件摘要** - 查找如 `README.md`、`LEIAME.md`、`CONTRIBUTING.md` 或类似的文档文件。 - 对新开发者最相关的部分提供客观但详细的摘要,包括: - 项目概述 - 如何在本地设置并运行系统 - 采用的标准与规范 - 贡献指南(如果存在) - 这些文档可以在哪里找到,或者如何生成? --- ### 8. **图表** - 生成高层级图表以可视化系统架构和行为: - 组件图(突出主要模块及其交互) - 数据流图(展示信息在系统中的流动方式) - 类图(展示关键类及其关系,如适用) - 简化部署图(组件运行的位置,如可检测到) - 简化基础设施/部署图(如可明显看出基础设施细节) - **使用 Mermaid 语法在 Markdown 文件中创建这些图表。** - 图表应为**高层级**;无需详尽细节。 --- ### 9. **测试** - 是否存在自动化测试? - 单元测试 - 集成测试 - 端到端(E2E)测试 - 它们在项目中的位置是哪里? - 使用了哪些测试框架? - 测试通常如何执行? - 如何在本地运行测试? - 是否有涉及测试的 CI/CD 策略? --- ### 10. **错误处理与日志记录** - 应用程序通常如何处理错误? - 是否有标准模式(例如全局中间件、自定义异常)? - 使用了哪个日志记录库? - 是否有标准的日志格式? - 是否可见与监控工具的集成(例如 Datadog、Sentry)? --- ### 11. **安全考虑** - 代码中是否存在明显的安全机制? - 身份验证 - 授权(中间件/过滤器) - 输入验证 - 是否显著使用了特定安全库(例如 Spring Security、Passport.js、JWT 库)? - 是否存在值得注意的安全实践? - 密钥管理 - 防护常见攻击 --- ### 12. **其他相关观察(包括构建/部署)** - 是否存在与**构建或部署**相关的文件? - `Dockerfile` - `docker-compose.yml` - 构建/部署脚本 - CI/CD 配置文件(例如 `.github/workflows/`、`.gitlab-ci.yml`) - 这些文件表明应用程序是如何构建和部署的? - 是否还有其他对新开发者至关重要或特别有帮助的内容? - 注释中提到的技术债务 - 不寻常的设计模式 - 重要的编码规范 - 性能说明 --- ## **最终输出格式** - 将完整响应生成为一个**格式良好的 Markdown(`.md`)文档**。 - 使用**清晰直接的语言**。 - 按照上述编号部分使用**标题和子标题**组织内容。 - **包含相关的代码片段**(简短且具代表性)。 - **包含可点击链接**,链接至被提及的具体代码元素:文件、函数、类和定义。 - 使用上述编号部分来结构化文档,以提高可读性。 **尽可能做到:** - 包含**可点击链接**至文件、函数和类。 - 展示**简短、具代表性的代码片段**。 - 对列表使用**项目符号或表格**。 --- ### **重要** 分析必须考虑项目中的**所有文件**。 阅读并理解完成此任务所需的所有必要文件,以全面掌握系统。 --- ### **操作** 请分析当前在我的环境/工作区中可用的源代码,并按要求生成 Markdown 文档。 输出文件名必须遵循以下格式: `<yyyy-mm-dd-project-name-app-dev-discovery_cursor.md>`
分类与标签
编程开发、编程开发、代码、分析