write-clear-readme

Name: write-clear-readme
Availability: InStock
Author: Coroboros

Audit, restructure, and polish repository READMEs with anchor validation.

2|Updated Apr 22, 2026

Search Tags:#documentation #audit #clarity #readme #structure #polish #anchor-integrity

Ready to run

npx skills add https://github.com/coroboros/agent-skills --skill write-clear-readme

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: write-clear-readme
Source: https://github.com/coroboros/agent-skills/tree/main/skills/write-clear-readme
Command: npx skills add https://github.com/coroboros/agent-skills --skill write-clear-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Author, audit, or polish a project README — clarity, structure (Pattern A grouped collapse / Pattern B per-entry collapse), wording concision, anchor integrity. Reads the repo first, proposes diffs, applies on approval.

Core Features & Use Cases

Audit README structure to improve readability and navigability.
Apply collapse patterns (Pattern A or Pattern B) to organize content without sacrificing anchors.
Propose, preview, and apply diffs with user approval to preserve existing workflows.

Quick Start

Audit, restructure, or polish the repository README to improve clarity and navigability.

Frequently Asked Questions about write-clear-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I audit a README for clarity and structure?▼

To audit a README for clarity, the tool reads the repository content and evaluates wording concision, structural scannability, and anchor integrity. It then proposes explicit diffs for approval to restructure the document without breaking existing navigability.

What is the best way to restructure a monorepo README for readability?▼

Restructuring a monorepo README is best handled by applying grouped collapse strategies (Pattern A) or per-entry collapse strategies (Pattern B). These patterns organize dense content while validating anchors to maintain scannability and navigability for complex project documentation.

How do I fix broken anchor links in a repository README?▼

Fixing broken anchor links in a repository README requires validating anchor integrity during the audit phase. The tool checks collapsed sections for navigation consistency and proposes targeted diffs to repair anchors before applying any structural changes.

Can I polish a CLI manual or npm SDK reference without losing existing anchors?▼

Yes, you can polish a CLI manual or npm SDK reference without losing existing anchors. The tool validates anchor integrity throughout the restructuring process and proposes diffs with explicit user approval to preserve all navigation links while improving wording concision.

Does the README polishing process apply changes automatically?▼

No, the README polishing process does not apply changes automatically. It proposes and previews diffs requiring explicit user approval before any modifications are made, ensuring existing workflows and repository content remain preserved during structural reorganization.