Crafting Effective Readmes

pedronauck/skills

This one actually asks good questions before generating boilerplate. It figures out whether you're writing for open source contributors, teammates, or future-you digging through config files, then adjusts the template accordingly. The four-step flow (identify task, ask context questions, draft, then check what's missing) is solid. Includes specific templates for OSS, personal projects, internal docs, and XDG configs. The "always ask who will read this" framing is obvious in retrospect but easy to forget when you're just trying to document something quickly. Works for creating new READMEs or updating stale ones.

skills.sh installs

254

GitHub stars

652

last updated

Aug 21, 2026

Sponsors

Promote your product hereReach 125k+ visitors monthlyPromote your product hereReach 125k+ visitors monthlyAgent CaffeineSponsoredClose your lid, come back to finished workSnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthlyWaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthlyknobsSponsoredSee your site on any phone, any day, in any language

Recommended

More Documentation

1excalidraw-studiotech-leads-club/agent-skillsGenerate Excalidraw diagrams from natural language descriptions. Outputs .excalidraw JSON files openable in Excalidraw. Use when asked to "create a diagram", "m251skills.sh installs

2aws-strandshoodini/ai-agents-skillsBuild AI agents with the Strands Agents SDK - the open-source framework (the agent "brain") for writing agent logic, tools, and multi-agent systems in Python. M249skills.sh installs

3kiss-principlemarkpitt/claude-skillsApply the K.I.S.S principle (Keep It Simple, Stupid) to reduce complexity, improve maintainability, and solve problems elegantly. Use when designing systems, wr248skills.sh installs

4communication-storytellinglyndonkl/claudeTransforms analysis, data, and complex information into clear, persuasive narratives tailored to specific audiences — executives, customers, investors, or non-t245skills.sh installs

5markdown-formattermarkpitt/claude-skillsFormats markdown files according to best practices and common style guidelines. Use when cleaning up markdown documentation, ensuring consistent formatting, or 244skills.sh installs

6stakeholder-commsanthropics/knowledge-work-pluginsDraft stakeholder updates tailored to audience — executives, engineering, customers, or cross-functional partners. Use when writing weekly status updates, month239skills.sh installs