메뉴
Generates AI-authored code reading guides from a project or module. Invoke when user asks to read code, summarize architecture, and write a guide document.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | AI_Generated_Code_Reading_Guide_Skill |
| description | Generates AI-authored code reading guides from a project or module. Invoke when user asks to read code, summarize architecture, and write a guide document. |
该 Skill 用于在代码仓库中生成“AI 阅读代码后输出的代码导读文档”。
适用场景：
输出目标：
生成导读文档时，遵循以下原则：
先界定边界
先读说明文档，再读代码
README.md、README_zh.md。聚焦主体代码
从“读者快速理解”出发组织内容
明确是 AI 生成
收到用户需求后，先确认：
README_zh.md如果用户已经明确给出这些信息，则直接进入下一步。
优先阅读：
README.mdCMakeLists.txtREADME_zh.md建立以下初步认知：
重点阅读以下类型文件：
梳理时重点回答：
建议导读文档采用类似结构：
如果目录不是库而是应用组件，还应明确说明：
main建议在文档一级标题下方加入统一说明：
说明：本文档由 AI 在阅读当前目录代码后生成，目标是帮助读者快速理解代码结构、模块职责与主要运行流程，作为代码导读使用。
如果用户希望文档名更专业，并突出导读和 AI 生成属性，推荐格式：
<module>_AI_Generated_Code_Reading_Guide.md例如：
volc_conv_ai_AI_Generated_Code_Reading_Guide.mdapplication_AI_Generated_Code_Reading_Guide.md语言跟随用户
结构化表达
强调“导读”
尊重代码现状
不夸大
可以按以下模板生成文档：
# `<模块名>` 代码梳理
> 说明：本文档由 AI 在阅读当前目录代码后生成，目标是帮助读者快速理解代码结构、模块职责与主要运行流程，作为代码导读使用。
## 1. 项目定位
## 2. 对外 API 边界
## 3. 代码总体结构
## 4. 核心流程
## 5. 关键模块说明
## 6. 构建与运行关系
## 7. 一句话总结
用户请求：
“阅读 /path/to/project/module 下的主体代码并总结，把总结写到 code_map.md 里。注意对外暴露的 API 只有 inc 目录中的。”
处理要点：
inc/ 公共头文件，确定 API 边界。inc 为对外 API”。用户请求：
“阅读该目录下主体代码并总结，把总结写到 code_map.md 里。注意阅读各个子目录中的 README_zh.md 文件，帮助理解。”
处理要点：
README_zh.md。生成文档后，检查以下事项：