← 返回 Skills 市场
133
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install readme-authoring
功能描述
Deep README workflow—audience, value proposition, quickstart, configuration, troubleshooting, contributing, and badges/links hygiene. Use when bootstrapping...
安全使用建议
This is a low-risk, instruction-only skill for producing better README files. Before installing or invoking it, note that: (1) it does not request credentials or install anything, (2) it recommends verifying quickstarts in CI or on a fresh machine — if you allow an agent to execute commands, review any generated run/CI scripts before executing, and never paste real secrets into generated examples, and (3) standard caution applies if you give the agent runtime or command-execution capabilities (those risks come from the agent environment, not this skill).
功能分析
Type: OpenClaw Skill
Name: readme-authoring
Version: 1.0.0
The skill bundle provides a structured workflow and best practices for authoring repository README files, covering audience definition, quickstart guides, and security considerations. The content in SKILL.md is purely instructional and advisory, promoting good documentation habits (such as avoiding hardcoded secrets) without any executable code, suspicious network requests, or malicious prompt injection attempts.
能力评估
Purpose & Capability
The name/description (deep README workflow) matches the SKILL.md content. The skill is purely authoring guidance and does not request binaries, environment variables, or access to external services that would be unrelated to producing README content.
Instruction Scope
SKILL.md contains structured authoring guidance and checklists only. It does not instruct the agent to read arbitrary system files, access credentials, or send data to external endpoints. It recommends verifying quickstarts in CI or a fresh machine, which is reasonable guidance but is not an instruction to automatically execute commands or access secrets.
Install Mechanism
No install spec and no code files — instruction-only skills have the lowest install risk. Nothing is downloaded or written to disk by the skill itself.
Credentials
The skill requests no environment variables or credentials. It mentions documenting environment variables for the project (as content guidance) but does not attempt to read or require them.
Persistence & Privilege
always is false (default), model invocation is allowed (normal), and the skill does not request persistent presence or modify other skills/configs. There are no elevated privileges requested.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install readme-authoring - 安装完成后，直接呼叫该 Skill 的名称或使用
/readme-authoring触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
- Initial release of readme-authoring skill with a comprehensive, six-stage workflow for crafting high-quality READMEs.
- Provides detailed guidance for audience targeting, quickstart instructions, configuration, operations, contribution, and maintenance.
- Includes best practices for badges, documentation hygiene, and security disclosures.
- Offers a final checklist to verify README effectiveness and usability.
- Tailored for both open-source and internal library repositories, with specific advice for monorepos and deep documentation.
元数据
常见问题
Readme Authoring 是什么？
Deep README workflow—audience, value proposition, quickstart, configuration, troubleshooting, contributing, and badges/links hygiene. Use when bootstrapping... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 133 次。
如何安装 Readme Authoring？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install readme-authoring」即可一键安装，无需额外配置。
Readme Authoring 是免费的吗？
是的，Readme Authoring 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
Readme Authoring 支持哪些平台？
Readme Authoring 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 Readme Authoring？
由 mike47512（@mike47512）开发并维护，当前版本 v1.0.0。
推荐 Skills