← Back to Skills Marketplace
133
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install readme-authoring
Description
Deep README workflow—audience, value proposition, quickstart, configuration, troubleshooting, contributing, and badges/links hygiene. Use when bootstrapping...
Usage Guidance
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).
Capability Analysis
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.
Capability Assessment
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.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install readme-authoring - After installation, invoke the skill by name or use
/readme-authoring - Provide required inputs per the skill's parameter spec and get structured output
Version History
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.
Metadata
Frequently Asked Questions
What is Readme Authoring?
Deep README workflow—audience, value proposition, quickstart, configuration, troubleshooting, contributing, and badges/links hygiene. Use when bootstrapping... It is an AI Agent Skill for Claude Code / OpenClaw, with 133 downloads so far.
How do I install Readme Authoring?
Run "/install readme-authoring" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Readme Authoring free?
Yes, Readme Authoring is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Readme Authoring support?
Readme Authoring is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Readme Authoring?
It is built and maintained by mike47512 (@mike47512); the current version is v1.0.0.
More Skills