是我自己在 AI Coding 时，为方便 AI 提前阅读现有项目工程文件、撰写上下文信息的提示词。
其流程是：

flowchart TD
    A[项目源代码] --> B[读取与分析工程文件]
    B --> C[归纳项目上下文信息]
    C --> D[生成 about.md 文档]
    D --> E[AI Coding 获取准确上下文]
    E --> F[高效完成代码生成/修改/测试]
    F --> G[项目演进与持续集成]
    G --> B

这事儿的必要性也可以结合 [[Claude Code 智能编码最佳实践指南]] 一起理解。

以下是经过 ChatGPT 优化过的提示词：

请担任 AI 编码助手的角色，阅读并分析整个项目工程文件（不限于特定技术栈或框架类型），并根据以下要求撰写一份详细的项目上下文文档 `about.md`，放置于项目根目录。文档需采用清晰、结构化的 Markdown 格式，专为后续 AI Coding 提供准确、高效的上下文参考。

**文档内容应包含以下方面（按需补充或省略不适用项）：**

- **常用命令与脚本**
   列出项目中用于构建、测试、运行、部署的常用命令和脚本（如 `npm run build`、`make test`、`python manage.py migrate` 等）。
- **项目结构与模块归纳**
   总结项目的目录结构，归类各主要模块、子模块、公共库、工具组件及其功能角色。清晰标出第三方依赖或特殊插件。
- **重要函数、接口与工具使用方式**
   汇总关键函数、API 接口、工具库或模块的**调用方式**与**使用示例**。仅需描述接口层面的调用与用途，无需展开源代码细节分析。
- **代码风格与规范**
   总结项目中显式或隐式遵循的代码风格指南（如模块引入规则、命名风格、禁止使用特定语法特性等）。
- **开发流程与协作规范**
   描述标准的开发工作流，包括但不限于：如何运行测试、如何提交代码、PR 审核流程、分支管理策略、版本控制规范等。
- **注意事项与限制警告**
   汇总项目中需要特别注意的问题、已知坑点、禁用 API、环境依赖或任何影响开发效率和正确性的提醒。
- **团队约定与最佳实践**
   记录项目中特有的团队协作约定、命名约定、注释规范、文件组织策略、模块化设计要求等。
- **其他有助于理解和开发的信息**
   包括任何未在以上分类中覆盖，但对理解整体工程有重要价值的补充说明。

**要求标准：**

- 以清晰、简洁、结构化（主标题、子标题、列表）的 Markdown 格式输出。
- 优先突出关键信息，避免无关细节或重复表述。
- 保持条理性，方便后续 AI 快速索引与调用上下文。
- 语言风格偏向简明、客观、面向工程实践。

以下是针对一个 Unity 引擎技术框架工程的特殊简化版：

请担任 AI 编码助手的角色，阅读 Unity 游戏引擎框架项目的所有工程文件，并根据以下要求撰写一个项目上下文信息文档 `about.md`（位于项目根目录下）。文档需采用清晰、结构化的 Markdown 格式（主标题、子标题分明，段落简洁，每段 3-5 句），并面向 AI 理解优化。文档内容应详尽地包含以下部分：

- **常用命令**：列出项目中的常用构建、运行和测试命令（例如 `npm run build`、`make test` 等）。
- **项目结构与模块概览**：说明项目的整体目录结构，描述各子模块、公共工具库和第三方依赖及其功能分类。
- **重要函数、接口与工具库使用方法**：介绍关键函数、API 接口和工具库的调用方式及示例（仅需给出调用示例，无需深入源代码实现细节）。
- **代码风格指南**：阐述项目的代码规范（如语言版本、命名约定、模块引入方式、禁止使用 `var` 等）。
- **开发流程**：说明如何运行测试、提交 PR、分支管理策略等团队开发流程。
- **注意事项与警告**：列出使用时需要注意的问题（如禁用的 API、特殊环境需求等）。
- **团队约定**：说明项目的特殊约定或团队标准（例如目录命名规则、注释格式要求等）。
- **其他相关信息**：包括任何有助于 AI 理解项目和后续开发的其他信息。

请确保内容详尽完整但不过度冗长，重点突出核心信息，使用标题、小节和列表等方式组织文档结构。

这样做的好处是：

1. 为 AI Coding 提供完整的上下文基座

AI 在编码时最怕「不知道项目背景」导致理解错误。
通过预先生成 about.md，AI 相当于「有了项目手册」，能迅速掌握：

  • 目录结构
  • 模块功能
  • 接口使用方法
  • 特殊规范
    => 极大减少理解成本，提升代码质量和准确率。

2. 标准化不同项目的「预处理流程」

不同项目可能语言、框架、规范各异，但通过你的提示词，可以统一生成结构一致的上下文文档：

  • 新项目上手更快
  • 老项目迁移/交接更规范
  • 多人协作时 AI 也能适配不同代码风格

3. 提升 AI 生成代码的连贯性与一致性

如果没有统一上下文，AI 可能出现：

  • 风格不统一（有时用 ESModules，有时用 CommonJS）
  • 调用错误（用错库、搞错模块接口）
  • 测试、部署流程遗漏
    而有了 About.md，AI 可以根据明确标准一致输出，有助于维护整个工程的一致性。

4. 显著提高开发效率

尤其是：

  • 自动化补全
  • 批量生成模块
  • 自动写测试用例
  • 快速 Debug
    => 因为 AI 已经「知道」项目规则和模块边界了，不需要来回推测。

5. 降低新成员（包括人类开发者）学习成本

不仅是 AI，人类新人也可以直接阅读 About.md，快速了解项目结构和开发规范。
相当于为项目建立了内置新手村，大大降低上手难度。

6. 未来还能扩展成工具链的一部分

比如可以搭配：

  • 自动更新 About.md（CI/CD 流程钩子）
  • 在 PR 审查时检查是否违反上下文规范
  • 根据上下文生成文档、代码 scaffold、配置文件
    => 形成完整的AI 辅助开发生态。

小结一句话

你正在为 AI 和开发者打造一个“项目理解层”，这是提升智能开发能力的基础设施。