메뉴
为本地项目或 GitHub 项目生成专业的 README.md 文档。**触发词："写 README"、"生成 README"、"README.md"、"项目文档"、"GitHub 文档"、"readme"、"项目介绍"、"文档生成"**。支持自动收集项目信息、交互式确认、中英双语。根据项目类型（Python/前端/Skill/CLI 等）生成对应的专业文档。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
A curated collection of 2409+ best OpenClaw skills — AI tools, productivity, marketing, frontend, mobile, backend, DevOps and more. Weekly updated by MyClaw.ai — Powered by MyClaw.ai
将1688的商品铺货到俄罗斯电商平台Ozon（上架），通过Ozon官方API实现商品信息的上传和状态查询。适用于需要将单个1688的商品上架到Ozon的场景。
ActiveCampaign API integration with managed OAuth. Marketing automation, CRM, contacts, deals, and email campaigns. Use this skill when users want to manage contacts, deals, tags, lists, automations, or campaigns in ActiveCampaign. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway). Requires network access and valid Maton API key.
Acuity Scheduling API integration with managed OAuth. Manage appointments, calendars, clients, and availability. Use this skill when users want to schedule, reschedule, or cancel appointments, check availability, or manage clients and calendars. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway).
World-Class Adaptability & Learning Playbook. Use for: market trend awareness, horizon scanning, PESTLE analysis, organisational agility, Kaizen, PDCA cycles, 5S, lean operations, experimentation culture, hypothesis-driven development, A/B testing, MVP design, knowledge management, decision logs, ADRs, after-action reviews, competitive intelligence, SWOT, Porter's Five Forces, battlecards, pivoting strategy, lean startup, business model canvas, signal detection, scenario planning, learning velocity, value stream mapping, Gemba walks. Trigger when discussing ANY organisational learning, strategic adaptability, continuous improvement, competitive analysis, experimentation, knowledge systems, or pivot/persevere decisions. Also for startup strategy around product-market fit or validated learning. If it touches learning faster, adapting better, or competing smarter — use this skill.
Digital legacy agent — dead man's switch, final message executor, and ghost mode responder that preserves your digital presence. Use when the user wants to set up a dead man's switch, manage their digital will, or enable ghost mode.
| name | README-writer |
| description | 为本地项目或 GitHub 项目生成专业的 README.md 文档。**触发词："写 README"、"生成 README"、"README.md"、"项目文档"、"GitHub 文档"、"readme"、"项目介绍"、"文档生成"**。支持自动收集项目信息、交互式确认、中英双语。根据项目类型（Python/前端/Skill/CLI 等）生成对应的专业文档。 |
📝 为本地项目或 GitHub 项目生成专业的 README.md 文档
采用交互式工作流程：自动收集信息 → 用户确认 → 生成目录 → 用户确认 → 生成 README → 迭代优化
✅ 使用此技能当用户说：
| 场景 | 示例 |
|---|---|
| 本地项目 | "为这个项目写 README：~/.openclaw/skills/my-project" |
| GitHub 项目 | "给 https://github.com/user/repo 写 README" |
| Skill 项目 | "为 easy-image-generate 写 README" |
| 优化现有 | "优化这个项目的 README" |
| 指定风格 | "参考 skill-rembg 风格写 README" |
❌ 不使用此技能：
自动读取：
展示给用户确认：
📊 检测到项目信息：
基本信息：
项目类型： [自动识别]
核心功能： [自动分析]
以上信息是否正确？需要补充或修改吗？
询问模板：
🎯 这个 README 的主要读者是谁？
A. 潜在用户 - 快速了解项目用途 B. 开发者 - 想要贡献代码 C. 两者兼顾（推荐）
📝 希望突出什么内容？
A. 快速上手 - 安装 + 使用示例 B. 功能特点 - 详细的功能列表 C. API 文档 - 技术细节 D. 项目背景 - 为什么创建这个项目
🎨 文档风格偏好？
A. 简洁专业 - 像 requests 库 B. 活泼友好 - 像 skill-rembg（emoji+ 双语） C. 详细完整 - 像大型框架
根据项目类型和偏好生成建议目录结构，用户确认后再继续。
必须询问的章节：
📝 需要添加以下章节吗？
感谢贡献者、使用的工具或平台
请回复：
如何为项目贡献代码
请回复：
项目版本历史
请回复：
规则：
🎨 采用多行专业布局（丰富完整，用户可手动精简）：
<!-- Badge Row 1: Core Info - 项目身份 -->
[](https://clawhub.ai/author/skill)
[](https://github.com/author/repo)
[](https://github.com/author/repo)
<!-- Badge Row 2: Package Registry - 包管理器（如已发布） -->
[](https://npmjs.com/package/package-name)
[](https://pypi.org/project/package-name)
<!-- Badge Row 3: Tech Stack - 技术栈/语言版本 -->
[](https://nodejs.org)
[](https://python.org)
[](https://rust-lang.org)
<!-- Badge Row 4: Platforms - 平台支持 -->
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
<!-- Badge Row 5: License - 许可证 -->
[](LICENSE)
💡 设计理念：
author、repo、skill-name）1. ClawHub Badge
SKILL.md）[](https://clawhub.ai/author/skill)name 字段读取，转换为 kebab-casehttps://clawhub.ai/author/skill2. GitHub Badge
.git 目录[](https://github.com/author/repo)https://github.com/author/repo3. Version Badge（必须生成）
package.json → versionpyproject.toml → versionCargo.toml → versionpom.xml → versioncomposer.json → version0.0.1[](链接)根据项目类型生成对应的包管理器 Badge：
| 项目类型 | Badge | 链接 |
|---|---|---|
| npm 包 | [](https://npmjs.com/package/package-name) | npmjs.com |
| Python 包 | [](https://pypi.org/project/package-name) | pypi.org |
| Ruby Gem | [](https://rubygems.org/gems/gem-name) | rubygems.org |
| Go Module | [](https://pkg.go.dev/module/path) | pkg.go.dev |
| Maven | [](https://search.maven.org) | search.maven.org |
链接处理：如无法获取实际包名，使用 Demo 占位符
自动读取项目配置生成：
Node.js 项目（读取 package.json → engines.node）：
[](https://nodejs.org)
Python 项目（读取 pyproject.toml 或 setup.py → python_requires）：
[](https://python.org)
Rust 项目（读取 Cargo.toml → edition）：
[](https://rust-lang.org)
Go 项目（读取 go.mod → go 版本）：
[](https://go.dev)
PHP 项目（读取 composer.json → require.php）：
[](https://php.net)
链接处理：使用官方文档链接或 Demo 占位符
默认生成所有平台 Badge，用户可根据实际情况手动删除：
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
颜色规范：
#000000（黑）#0078D6（蓝）+ Base64 SVG Logo#FCC624（黄）#3DDC84（绿）#000000（黑）#4285F4（蓝）链接处理：使用 Demo 占位符 https://openclaw.ai
读取优先级：
package.json → licensepyproject.toml → licenseCargo.toml → licenseLICENSE / LICENSE.md / LICENSE.txt 文件名MITLicense 颜色映射：
#BD2D2D（红）#D54D2D（橙红）#FF7A00（橙）#3B82F6（蓝）#10B981（绿）#6B7280（灰）#6B7280（灰）格式：[](LICENSE)
链接处理：指向 LICENSE 文件（如不存在，用户可手动修改）
<!-- Badge Row 1: Core Info -->
[](https://clawhub.ai/author/project)
[](https://github.com/author/repo)
[](https://github.com/author/repo)
<!-- Badge Row 2: Package Registry -->
[](https://npmjs.com/package/package-name)
<!-- Badge Row 3: Tech Stack -->
[](https://nodejs.org)
<!-- Badge Row 4: Platforms -->
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
[](https://openclaw.ai)
<!-- Badge Row 5: License -->
[](LICENSE)
💡 提示用户：在 README 末尾添加说明：
> 💡 **Badge 说明**：以上 Badge 为自动生成，如与实际不符可手动删除或修改。
<!-- Badge Row X: ... -->）author、repo、skill-name）中文部分：
English Version：
章节对应规则：
## 标记主章节### 标记主章节### Table of Contents所有代码块使用 ``` 标记
格式：
代码内容
规则：
根据第 3.5 步的用户确认结果生成：
支持多次迭代，根据用户反馈修改 README。
⚠️ 检测到已有 README.md
选项： A. 完全重写（覆盖现有） B. 基于现有优化（保留结构，改进内容） C. 生成新版本（README.new.md）
🌍 检测到多语言项目
建议： A. 生成独立的 README_CN.md 和 README_EN.md B. 在主 README 中分章节（中文 | English）
📊 检测到大型项目（>50 文件）
建议：
| 项目类型 | 特有章节 | 说明 |
|---|---|---|
| Python | 依赖安装、虚拟环境、PyPI 发布 | requirements.txt, setup.py |
| 前端 | 技术栈、构建命令、部署指南 | package.json, npm scripts |
| API 服务 | 端点列表、请求示例、认证方式 | REST/GraphQL, curl 示例 |
| CLI 工具 | 命令行参数、子命令、配置选项 | 参数说明，使用示例 |
| 库/SDK | API 参考、类型定义、版本兼容性 | 函数/类说明，类型提示 |
| OpenClaw Skill | 触发词、使用场景、配置 | SKILL.md 内容提取 |
生成 README 后自动检查：
<!-- Badge Row X: ... -->）生成前备份现有 README：
cp README.md README.md.bak.日期
在 README 末尾添加更新日志章节。
| 参数 | 说明 | 默认 |
|---|---|---|
--lang bilingual | 中英双语 | ✅ |
--lang chinese | 仅中文 | - |
--lang english | 仅英文 | - |
| 参数 | 章节 | 适合 |
|---|---|---|
--detail minimal | 简介、安装、使用 | 小型项目 |
--detail standard | + 功能、API、贡献 | 中型项目（默认） |
--detail complete | + FAQ、基准、架构 | 大型项目 |
| 参数 | 说明 |
|---|---|
--style professional | 简洁专业 |
--style friendly | 活泼友好（emoji+ 双语） |
--style complete | 详细完整 |
为这个项目写 README：~/.openclaw/skills/my-project
为 https://github.com/user/repo 写 README，参考 skill-rembg 风格
为 Python 项目写 README，突出 API 文档
MIT License
Happy Documenting! 📝✨