cmd-idiot-proof-docs

What problem does it solve?

This Skill addresses the challenge of creating documentation that is difficult for both humans and AI agents to understand, execute, and maintain. It aims to make documentation clear, concise, and actionable.

Core Features & Use Cases

• Clarity and Scannability: Rewrites documentation to be easily scanned and understood.
• Approval-Gated Edits: Ensures all changes are previewed and explicitly approved before being applied.
• Optimized Structure: Enforces a specific order for documentation sections (Quickstart, Main Workflow, etc.) to improve usability.
• Use Case: Refactor a complex README file for a new open-source project to ensure new contributors can quickly understand how to set up and run the project.

Quick Start

Use the cmd-idiot-proof-docs skill to rewrite the documentation in the current directory for better clarity.