تشغيل أي مهارة في Manus بنقرة واحدة

ابدأ الآن

readme-init

النجوم١

التفرعات٠

آخر تحديث٦ يونيو ٢٠٢٦ في ١٧:٥٣

扫描项目自动生成或刷新 README(检测技术栈/结构/可运行脚本)。用户说「/readme-init」「帮我生成 README」「项目没有 README,帮我写一个」「刷新/更新 README」「README 太旧了帮我刷新」时触发。

التثبيت

التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.

تشغيل في Manus

المصدر

YuAICode

YuAICode/ai-skills

فتح مستودع GitHub عرض مستودعات المنشئ

تنزيل

تشغيل في Manus

المهن ذات الصلةSOC

استنادا إلى تصنيف SOC المهني

مطوّرو البرمجياتمهن الحاسوب والرياضيات·SOC 15-1252

مستكشف الملفات

4 ملفات

SKILL.md

readonly

name	readme-init
description	扫描项目自动生成或刷新 README(检测技术栈/结构/可运行脚本)。用户说「/readme-init」「帮我生成 README」「项目没有 README,帮我写一个」「刷新/更新 README」「README 太旧了帮我刷新」时触发。

readme-init — 项目 README 自动生成 / 刷新

扫描目标项目的技术栈、入口文件、可运行脚本、目录结构,据此让 Claude 撰写或刷新一份中文 README。核心原则:只写扫描到的真实事实,拿不准的标「待补」,不臆造功能或命令。

何时触发

用户说以下任意一种:

/readme-init 或 /readme-init <项目目录>
"帮我生成 README" / "这个项目没有 README,帮我写一个"
"刷新/更新 README" / "README 太旧了/不准了"
"给这个仓库补一份文档"

用法

1. 扫描项目

bash <skill>/bin/scan-project.sh [项目目录]
# 默认当前目录;输出四个段落:
#   LANGUAGES   — 检测到的编程语言/运行时
#   SCRIPTS     — package.json / Makefile / composer.json 中可运行命令
#   ENTRYPOINTS — 存在的常见入口文件
#   STRUCTURE   — 顶层目录与关键文件(忽略 node_modules/.git/dist/build 等)

2. 流程

扫描:跑 bin/scan-project.sh <项目目录>,拿到结构化事实。
判断是否已有 README:
- 无 README:按下方模板从零生成。
- 已有 README:先读原文,在尊重原有内容的基础上,仅补缺/更新与扫描结果不符的部分,不全量覆盖。
写 README:依据扫描事实填充模板各节。拿不准的内容一律标 （待补）。
写入文件:默认写到 <项目目录>/README.md;若已有 README 则在确认后覆盖。
报告:列出已填写的章节、标为「待补」的项目。

README 模板(新建时使用)

# <项目名>

> <一句话简介>（待补:请补充项目用途）

## 技术栈

- <语言/框架>(来自 LANGUAGES 扫描)

## 安装

```bash
# 待补:根据项目实际安装步骤填写

运行

# 来自 SCRIPTS 扫描,如:
# npm run build
# make test

项目结构

<来自 STRUCTURE 扫描,列顶层目录与关键文件>

许可

（待补:未检测到 LICENSE 文件,请补充）


## 硬规则

1. **基于事实**:只写扫描到的语言、脚本、文件。未扫描到的功能/命令不得出现。
2. **拿不准就标「待补」**:项目简介、作者、许可等无法自动推断的内容,一律用 `（待补）` 占位。
3. **已有 README 尊重原文**:补缺优先,改动最小化;不删除原有人工内容。
4. **不执行脚本**:只读取/解析文件,不运行任何项目构建或测试命令。
5. **中文输出**:生成的 README 使用简体中文;代码块、路径、命令保持英文。

## 边界

- `bin/scan-project.sh` 纯 bash + grep,无需 jq/python/node 等外部工具,离线可用。
- 不自动 push/commit;写完后告知用户文件路径,由用户决定是否提交。
- 不处理多 repo monorepo 的子包递归扫描;只扫单一项目根目录。
- 框架/语言靠清单文件推断,无清单文件的项目会尝试文件扩展名兜底(maxdepth 3)。

المزيد من هذا المستودع

نفس المستودع

claude-code-zh

YuAICode/ai-skills

把 Claude Code 汉化 —— 让 Claude 默认用中文回复,并给每个工具调用加中文 tooltip 提示。当用户想"汉化 Claude Code""让 Claude 说中文""装中文命令提示""localize Claude Code to Chinese"时使用。

2026-06-091

branch-cleaner

YuAICode/ai-skills

列出可清理的本地分支(已合并 / 陈旧),供用户确认后再删。当用户说"清理分支 / 哪些分支可以删 / 列出过期分支 / 整理 git 分支 / 哪些分支可以清掉"时触发。

2026-06-071

code-haiku

YuAICode/ai-skills

把一个函数/代码片段/diff 写成一首俳句或打油诗,抓住代码的「神韵」。当用户说「给这段代码写首诗」、「code-haiku」、「把这个函数写成俳句」、「这个 diff 怎么用诗表达」时触发。

2026-06-071

git-blame-story

YuAICode/ai-skills

把一个文件的修改史讲成故事——谁、何时、为何改了它。当用户说「讲讲这个文件的故事 / git-blame-story / 这个文件经历了什么 / 追溯文件历史 / 帮我看看这个文件的来龙去脉」时触发。

2026-06-071

dockerfile-doctor

YuAICode/ai-skills

扫描 Dockerfile 的体积/安全/缓存/最佳实践问题并给出中文修法。当用户说"帮我检查 Dockerfile / Dockerfile 有没有问题 / 审查 Dockerfile / dockerfile-doctor"时触发。

2026-06-061

mock-data-gen

YuAICode/ai-skills

按表结构 / struct / TS interface / JSON shape 生成假数据与测试种子数据,支持 JSON / SQL INSERT / CSV / NDJSON 输出格式。触发词:/mock-data-gen、帮我生成测试数据、帮我造数据、生成假数据、生成种子数据。

2026-06-061

readme-init — 项目 README 自动生成 / 刷新

何时触发

用户说以下任意一种:

/readme-init 或 /readme-init <项目目录>

"帮我生成 README" / "这个项目没有 README,帮我写一个"

"刷新/更新 README" / "README 太旧了/不准了"

"给这个仓库补一份文档"

用法

1. 扫描项目

bash <skill>/bin/scan-project.sh [项目目录] # 默认当前目录;输出四个段落: # LANGUAGES — 检测到的编程语言/运行时 # SCRIPTS — package.json / Makefile / composer.json 中可运行命令 # ENTRYPOINTS — 存在的常见入口文件 # STRUCTURE — 顶层目录与关键文件(忽略 node_modules/.git/dist/build 等)

2. 流程

扫描:跑 bin/scan-project.sh <项目目录>,拿到结构化事实。

判断是否已有 README:

无 README:按下方模板从零生成。
已有 README:先读原文,在尊重原有内容的基础上,仅补缺/更新与扫描结果不符的部分,不全量覆盖。

写 README:依据扫描事实填充模板各节。拿不准的内容一律标 （待补）。

写入文件:默认写到 <项目目录>/README.md;若已有 README 则在确认后覆盖。

报告:列出已填写的章节、标为「待补」的项目。

README 模板(新建时使用)

# <项目名> > <一句话简介>（待补:请补充项目用途） ## 技术栈 - <语言/框架>(来自 LANGUAGES 扫描) ## 安装 ```bash # 待补:根据项目实际安装步骤填写

运行

# 来自 SCRIPTS 扫描,如: # npm run build # make test

项目结构

<来自 STRUCTURE 扫描,列顶层目录与关键文件>

许可

（待补:未检测到 LICENSE 文件,请补充）

## 硬规则 1. **基于事实**:只写扫描到的语言、脚本、文件。未扫描到的功能/命令不得出现。 2. **拿不准就标「待补」**:项目简介、作者、许可等无法自动推断的内容,一律用 `（待补）` 占位。 3. **已有 README 尊重原文**:补缺优先,改动最小化;不删除原有人工内容。 4. **不执行脚本**:只读取/解析文件,不运行任何项目构建或测试命令。 5. **中文输出**:生成的 README 使用简体中文;代码块、路径、命令保持英文。 ## 边界 - `bin/scan-project.sh` 纯 bash + grep,无需 jq/python/node 等外部工具,离线可用。 - 不自动 push/commit;写完后告知用户文件路径,由用户决定是否提交。 - 不处理多 repo monorepo 的子包递归扫描;只扫单一项目根目录。 - 框架/语言靠清单文件推断,无清单文件的项目会尝试文件扩展名兜底(maxdepth 3)。