skill-readme-rebuilder

What This Skill Does

The Skill README Rebuilder is an automated documentation assistant designed specifically for OpenClaw skill developers. It parses your existing skill directory—including SKILL.md, source scripts, and local resources—to generate, update, or synchronize your README.md, FAQ, and usage examples. By acting as a source-of-truth validator, it ensures that your technical documentation never drifts from your actual code implementation or dependency declarations.

Installation

To integrate this tool into your OpenClaw environment, use the following command: clawhub install openclaw/skills/skills/52yuanchangxing/skill-readme-rebuilder

Use Cases

• Documentation Bootstrapping: When starting a new skill, point the rebuilder at your empty project folder to generate a professional, compliant README structure based on your spec.json and template files.
• Refactoring Sync: After changing script arguments, API endpoints, or dependency requirements, use the rebuilder to audit your docs. It detects discrepancies between the code and your written claims.
• Content Expansion: Automatically generate high-quality FAQ sections and real-world usage examples by analyzing your tests/ directory and resources/ specifications, ensuring that users understand how to invoke your skill effectively.

Example Prompts

1. "Analyze the current directory and generate a draft README.md that matches my spec.json, highlighting any missing dependency declarations."
2. "I've added a new shell script to my skill. Can you audit the existing documentation and suggest updated FAQ entries based on the new logic?"
3. "Review my skill structure and provide a consistency report; specifically, check if the documentation claims matches the actual input parameters defined in my script."

Tips & Limitations

• Transparency First: The tool is designed to be a transparent assistant. It will not execute high-risk commands or bypass your security settings. If you require it to interface with file systems to save documents, ensure your environment permissions allow file-write access.
• Avoid Hallucinations: Do not use this tool to artificially inflate the capabilities of a script. It is configured to prioritize the reality of your code over persuasive copy. If a dependency isn't declared, the tool will flag it as a missing requirement rather than ignoring the omission.
• Consistency Checks: Always review the "Consistency Risk" section of the output before applying changes, as it identifies potential conflicts between your documentation intent and the technical reality of your skill.