吃透一个项目:把做过的项目变成能讲清楚的项目
2026/10/31约 1006 字大约 3 分钟
用在一场面试之前:让 AI 把项目拆成六份文档,每份都有明确的读者和质量标准。写完之后你能用一分钟讲清项目在解决什么问题,也能在追问里说清某个模块为什么这么设计。
我需要进行面试,岗位是Agent开发、大模型应用开发,需要将当前项目写入简历,你是一个专业的技术文档工程师,目标是为项目编写一套完整的技术文档,帮助我快速理解项目并准备面试。
📋 输出要求
在 docs/technical/ 目录下创建以下文档:
| 文件名 | 内容 | 目标读者 |
|---|---|---|
README.md | 文档导航、核心亮点速览、面试话术 | 所有人 |
01-architecture-overview.md | 系统架构总览、技术栈 | 有经验者 |
02-core-system-design.md | 核心系统设计详解 | 有经验者 |
03-key-algorithms.md | 关键算法/技术实现 | 有经验者 |
04-core-concepts-for-beginners.md | 概念大白话解释 | 零基础 |
05-interview-preparation.md | 面试话术、常见问题 | 求职者 |
🎯 文档质量标准
1. README.md 必须包含
- 📚 文档清单表格(含阅读时间估算)
- 🎯 推荐阅读顺序(分"零基础"和"有经验"两条路径)
- 💡 核心亮点速览(4-6个亮点,用 bullet list)
- 📊 项目数据表格(代码行数、核心模块数等)
- 🎤 面试话术速记(1分钟版本、3分钟版本)
- ⚠️ 注意事项(如不要背诵代码)
2. 技术文档(01-03)必须包含
- ASCII 架构图(用字符画展示系统结构)
- 技术栈表格(分层展示)
- 核心模块详解(每个模块说明职责、亮点)
- 关键设计决策说明(为什么选A而不是B)
3. 小白概念指南(04)必须包含
- 用"大白话"解释每个核心概念
- 类比(如"Embedding就像..."、"RAG就像...")
- 为什么要用这个技术(解决了什么问题)
- 不需要代码,建立直觉即可
4. 面试准备指南(05)必须包含
4.1 面试前准备清单
- 准备时间分配表
4.2 项目介绍话术
- 1分钟版本(电梯演讲)
- 3分钟版本(标准介绍)
- 5分钟版本(详细展示)
每个版本要有:
- 适用场景说明
- 完整话术(用引用块)
- 关键词标注
4.3 常见问题与回答(必背)
按主题分类,每个问题包含:
- 问题原文
- 完整回答(用引用块)
- 回答要点拆解
4.4 技术亮点总结
- 4个亮点,每个用 bullet list 说明
- 面试现场画图(ASCII图)
4.5 特殊问题处理
针对项目的特殊性(如"这个项目对你自己有什么帮助"),提供:
- 回答核心思路
- 完整回答示例
- 备选要点表格
- 避免的坑表格
📝 写作风格要求
- 表格优先:能用表格就不用列表,信息密度高
- 代码块标注:代码/话术用 ``` 包裹,标明语言
- emoji分级:用 📚🎯💡📊🎤 等增加可读性
- 具体数字:不说"代码量很大",说"15,000+行"
- 面试导向:每个技术点都想想"面试官会怎么问"
- 诚实原则:不夸大、不虚构,承认可以改进的地方
🔍 执行步骤
- 先读取项目代码,理解核心架构
- 识别3-5个技术亮点(区别于普通项目的点)
- 确定目标岗位(如Agent开发、后端开发等)
- 按上述要求编写文档
- 检查:小白能看懂吗?面试够用吗?
⚠️ 禁止事项
- ❌ 不写空洞的"项目背景/需求分析"
- ❌ 不堆砌技术名词不解释
- ❌ 不提供无法背诵的长篇大论
- ❌ 不写与面试无关的内容