README-writer 是 leoyeai/agent-master-skills 中的一项技能，用途是为本地项目或 GitHub 项目生成专业的 README.md 文档。
用途
当用户提出“写 README”“生成 README”“README.md”“项目文档”“GitHub 文档”“项目介绍”“文档生成”等需求时使用。适用于为本地路径中的项目、GitHub 仓库、Skill 项目撰写 README，也适用于优化现有 README，或按指定参考风格撰写 README。资料明确说明，不适用于代码审查、项目部署、问题排查等场景。
主要能力
采用交互式工作流程，共 11 步：用户输入本地路径或 URL→自动收集项目信息→展示信息并请用户确认或修改→询问 README 目的和风格偏好→生成建议目录结构→用户确认或调整目录→询问可选章节（致谢/贡献/更新日志）→生成 README 草稿→质量检查与用户反馈→迭代优化→输出最终版本并备份。
信息收集可读取 package.json、requirements.txt、pyproject.toml、Cargo.toml、主要语言文件、目录结构以及现有 README。生成内容支持中英双语，英文部分需完整翻译所有章节，并有独立的 Table of Contents。可根据项目类型生成特定章节，例如 Python 的依赖安装与 PyPI 发布、前端的构建命令与部署指南、API 服务的端点列表与请求示例、CLI 工具的命令行参数、库/SDK 的 API 参考等。
Badge 生成
在项目简介后生成 shields.io 徽章区域，采用多行布局并用 HTML 注释分行：核心信息（ClawHub、GitHub、Version）、包管理器（如 npm、PyPI 等）、技术栈/语言版本、平台（macOS/Windows/Linux/Android/iOS/Web）、许可证。Version 徽章必须生成，无版本号时使用 0.0.1；平台徽章默认全部生成，用户可手动精简；License 徽章读取实际许可证，无则默认 MIT；无法确定实际链接时使用 Demo 占位符。
使用方式
通过触发词或自然语言指令调用，例如：“为这个项目写 README：~/.openclaw/skills/my-project”“为 https://github.com/user/repo 写 README，参考 skill-rembg 风格”“为 Python 项目写 README，突出 API 文档”。资料列出配置选项：--lang bilingual/chinese/english；--detail minimal/standard/complete；--style professional/friendly/complete。
特殊场景
已有 README 时可选择完全重写、基于现有优化或生成 README.new.md；多语言项目可生成独立的 README_CN.md 和 README_EN.md，或在主 README 中分章节；大型项目（超过 50 个文件）建议 README.md 放简介与快速开始，详细文档放入 docs/ 目录。生成前会备份现有 README（如 cp README.md README.md.bak.日期）。
适用场景
适合需要快速产出结构清晰、含安装步骤、使用示例、功能列表、徽章和双语内容的项目文档的开发者；尤其适合开源项目、Skill 项目和需要同时面向用户与贡献者的仓库。
限制
资料未提供该技能的运行环境要求、依赖安装命令、性能指标或收费信息。资料说明部分徽章链接在无法确定时会使用占位符，需用户手动修改；平台徽章默认全部生成，可能与实际支持平台不符。资料中的质量检查清单和禁止项属于技能内部约束，而非外部验证结果。