Rewrite READMEs to follow a structured hierarchy and separate user from contributor content.
npx skills add https://github.com/prateek/dotfiles --skill readme-craft
Please help me install this Agent Skill. Skill: readme-craft Source: https://github.com/prateek/dotfiles/tree/main/.agents/skills/readme-craft Command: npx skills add https://github.com/prateek/dotfiles --skill readme-craft
READMEs often become bloated or misaligned with product goals. Readme Craft provides a structured method to write, rewrite, or audit READMEs to accelerate onboarding and reduce decision fatigue for users and contributors.
Rewrite the README to follow the recommended hierarchy, trim unnecessary content, and clearly separate user-facing guidance from contributor-facing information.
High-intent search queries and answers about installing and using this skill.
To restructure a README for faster adoption, rewrite it using a concise information hierarchy that prioritizes the billboard section within the first 29 lines to capture attention and convey value quickly.
The best way to separate user-facing content from contributor guidance is to rewrite the README by moving internal development details to external docs, ensuring the main file focuses strictly on user onboarding.
You audit an existing README by applying a structured workflow to trim unnecessary config dumps, eliminate duplicated content, and reorganize the remaining information into a clear, consistent hierarchy.
Yes, you can use a greenfield workflow to write project documentation from scratch, establishing a clear hierarchy and separating user content from contributor information right from the beginning.
The billboard section of a README should include the most critical orientation details that convey the project's value quickly, acting as a concise hook within the first 29 lines to accelerate user onboarding.
You should move technical documentation out of the README when it functions as a config dump or contributor-facing content, linking to external docs instead to reduce decision fatigue and maintain readability.
IngvarConsultingAnalyze 1C subsystem XML dumps to generate structure reports.
anavvanzinTranslate complex engineering concepts into developer-facing documentation.
ArtisanClarinetsStandardize technical documentation writing for READMEs, API docs, and engineering guides.
danzam98Revise AI-generated documentation line-by-line to remove telltale AI writing patterns.
