القائمة
根据当前工作目录的代码结构和内容，自动生成或更新 README.md 文件。Use when the user says '更新 README' / '生成 README' / '写 README' / 'update readme'，或要求根据项目内容刷新 README 时触发。
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | readme-update |
| description | 根据当前工作目录的代码结构和内容，自动生成或更新 README.md 文件。Use when the user says '更新 README' / '生成 README' / '写 README' / 'update readme'，或要求根据项目内容刷新 README 时触发。 |
扫描当前工作目录的项目结构、代码文件、配置文件等，自动生成或更新该目录下的 README.md。
通过 Bash 执行以下命令收集信息：
# 项目文件结构（仅展示前两层）
fd --max-depth 2 --type f
# 查找包管理/构建配置文件
fd -d 1 "(package\.json|Cargo\.toml|go\.mod|pyproject\.toml|setup\.py|CMakeLists\.txt|Makefile|\.csproj|pom\.xml|build\.gradle|\.uproject|tsconfig\.json|vite\.config|webpack\.config|docker-compose|Dockerfile)" --type f
# 查找已有 README
fd "README" --max-depth 1 --type f
# 如果是 git 仓库，获取远程地址
git remote -v 2>/dev/null | head -1
根据第 1 步的结果，读取以下文件（如存在）：
package.json、Cargo.toml、go.mod、pyproject.toml 等）：提取项目名、描述、依赖、脚本命令src/main.*、src/index.*、app.* 等）：了解项目核心功能docker-compose.yml、.env.example、tsconfig.json 等）：了解运行环境和配置重要：如果已有 README.md，必须先 Read 再决定更新策略。
如果项目文件较多（>20 个源文件），必须启动一个 general-purpose 子任务来分析代码。
子任务 prompt 示例：
请分析以下项目目录的代码结构：<当前目录>
文件列表：
<第1步获取的文件列表>
要求：
- 读取入口文件和关键模块，理解项目的核心功能
- 识别项目的技术栈和框架
- 总结项目的主要功能模块
- 以结构化文本返回分析结果，不要写入任何文件
如果项目较小，可以直接在主对话中读取分析。
根据收集到的信息生成 README。 只更新或生成仓库根目录下的README文件
如果是全新生成，使用以下结构：
# 项目名称
简要描述（1-2 句话说明项目是什么、解决什么问题）。
## 功能特性
- 特性 1
- 特性 2
- ...
## 技术栈
- 框架/语言
- 关键依赖
## 快速开始
### 环境要求
- Node.js >= xx / Python >= xx / ...
### 安装
```bash
安装命令
启动命令
目录结构概览（关键目录，不超过 2 层）
（如有 .env.example 或配置文件，说明关键配置项）
（如果 LICENSE 文件存在，注明类型）
**如果是更新已有 README**：
- 保留用户手写的自定义章节（如 Contributing、Acknowledgments 等）
- 仅更新可自动推导的章节（项目结构、技术栈、安装命令等）
- 不要删除现有内容，只补充缺失的部分
- 对于用户编写的描述性文字，保持原样，不要替换
## 注意事项
- README 语言默认跟随项目中已有 README 的语言；如无已有 README，使用中文
- 不要添加不存在的功能或虚构的信息，所有内容必须来自实际代码
- 保持简洁，避免废话
- 不要添加 badge/shield 图标，除非已有 README 中存在
- 如果项目有 `scripts` 字段（package.json）或 Makefile targets，列出常用命令
探索代码与文档以回答用户的疑问，不产出文档。TRIGGER WHEN: 用户提问、想了解现有实现、排查问题、搞清某功能如何工作时使用。
需求工作流入口。根据用户描述自动路由到对应的子流程。TRIGGER WHEN: 用户描述需求时使用。
理解拆解需求并生成设计文档。TRIGGER WHEN: 分析需求、拆解功能、产出边界或书写设计文档时使用。
根据设计文档实现代码。TRIGGER WHEN 当用户已完成需求设计文档、开始编码实现时使用，或需要修改代码时使用。
初始化需求工作环境。TRIGGER: 当用户说'初始化'、'story init'、'开始需求'、'环境准备'、'准备工作区'时使用。
Review 需求设计或代码实现。TRIGGER: 当用户说'开始 Review'、'审查代码'、'检查实现'时使用。