← 返回 Skills 市场
246
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install readme-writer-skill
功能描述
Expert README writing skill for open source projects. Use this skill whenever the user wants to write, improve, or review a README for any open source reposi...
安全使用建议
This skill appears coherent and low-risk because it's instruction-only and doesn't ask for credentials or install code. Before using it: (1) don't paste secrets or private tokens into prompts or READMEs you generate; (2) treat any example 'install' commands (notably 'curl | sh') as documentation examples only — verify the source before running them; (3) if you want the skill to analyze a repository, prefer providing a sanitized excerpt or grant minimal, explicit repository access rather than pasting entire config files; (4) if provenance matters, ask the publisher for source/homepage or request an auditable code-based implementation rather than an instruction-only skill.
功能分析
Type: OpenClaw Skill
Name: readme-writer-skill
Version: 1.0.0
The 'readme-writer-skill' is a well-structured tool designed to assist an AI agent in generating high-quality documentation for open-source projects. The bundle consists of a main instruction file (SKILL.md) and several reference documents (references/ai-ml.md, references/frameworks.md, references/tools.md) that provide templates and best practices based on popular GitHub repositories. There is no evidence of malicious intent, data exfiltration, or harmful prompt injection; the content is purely instructional and focused on its stated purpose of README generation.
能力评估
Purpose & Capability
Name/description (README writer) align with the provided assets: a SKILL.md plus three large references about README patterns for tools, AI/ML, and frameworks. There are no unexpected env vars, binaries, or install steps requested that would be unrelated to writing READMEs.
Instruction Scope
The SKILL.md describes how the agent should collect project information (ask the user or infer name, purpose, tech stack) and how to construct README content; it does not instruct the agent to read arbitrary host files, to access credentials, or to transmit repository contents to third parties. Note: the guidance contains example installation patterns (including 'curl -fsSL https://get.example.com | sh') and other sample commands which are presented as common README content — these are potentially unsafe patterns if executed by a user without verification, but they do not make the skill itself perform those actions.
Install Mechanism
There is no install spec and no code files that run on the host — this is instruction-only, which minimizes the risk of writing or executing new code on the machine.
Credentials
The skill declares no required environment variables, no primary credential, and no config paths; this is proportionate for a documentation/authoring skill.
Persistence & Privilege
always is false and model invocation is allowed (default). The skill does not request or modify other skills or system-wide settings; nothing here indicates elevated or persistent privileges.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install readme-writer-skill - 安装完成后，直接呼叫该 Skill 的名称或使用
/readme-writer-skill触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
- Initial release of the readme-writer skill.
- Provides expert guidance and templates for writing, improving, or reviewing READMEs for open source projects.
- Covers best practices and proven structures based on patterns from 20 high-star GitHub repositories, including tools, AI/ML projects, and code frameworks.
- Includes a comprehensive universal README structure and type-specific reference guides.
- Designed to help users create clear, compelling, and user-friendly project documentation.
元数据
常见问题
readme-writer-skill 是什么？
Expert README writing skill for open source projects. Use this skill whenever the user wants to write, improve, or review a README for any open source reposi... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 246 次。
如何安装 readme-writer-skill？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install readme-writer-skill」即可一键安装，无需额外配置。
readme-writer-skill 是免费的吗？
是的，readme-writer-skill 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
readme-writer-skill 支持哪些平台？
readme-writer-skill 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 readme-writer-skill？
由 caopulan（@caopulan）开发并维护，当前版本 v1.0.0。
推荐 Skills