Crafting Effective Readmes
by softaworks3027f20f3181No license2.5K starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 7 months ago
Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.
Only the file list is public. File contents are available once the skill is installed in a workspace.
| Path | Size | Type |
|---|---|---|
| README.md | 6 KB | text/markdown |
| references/art-of-readme.md | 23.9 KB | text/markdown |
| references/make-a-readme.md | 6.5 KB | text/markdown |
| references/standard-readme-example-maximal.md | 1.5 KB | text/markdown |
| references/standard-readme-example-minimal.md | 169 B | text/markdown |
| references/standard-readme-spec.md | 9.6 KB | text/markdown |
| section-checklist.md | 680 B | text/markdown |
| SKILL.md | 2.6 KB | text/markdown |
| style-guide.md | 434 B | text/markdown |
| templates/internal.md | 1.9 KB | text/markdown |
| templates/oss.md | 1.6 KB | text/markdown |
| templates/personal.md | 1.1 KB | text/markdown |
| templates/xdg-config.md | 1.4 KB | text/markdown |
| using-references.md | 1.3 KB | text/markdown |
Source and attribution
Source:softaworks/agent-toolkitinskills/crafting-effective-readmesat commit3027f20
License: No license
Content belongs to its original authors. SourceWeft indexes it from a public repository.
More from softaworks/agent-toolkit
C4 Architecture
softaworks
Generates C4 model architecture documentation as Mermaid diagrams in markdown files.
Writing Clearly And Concisely
softaworks
Applies Strunk's Elements of Style rules and an AI-writing-pattern checklist to make human-facing prose clearer and more concise.
Web To Markdown
softaworks
Converts webpage URLs into clean Markdown using a locally installed web2md CLI with Puppeteer and Readability.
Skill Judge
softaworks
Scores Agent Skill packages against official specifications and best practices, with multi-dimensional ratings and improvement advice.
Ship Learn Next
softaworks
Turns learning content such as transcripts or articles into a Ship-Learn-Next action plan with concrete weekly iterations.
Reducing Entropy
softaworks
Guides an agent to minimize total codebase size by biasing toward deletion and measuring the final code amount.
More in Writing & Content
Doc Coauthoring
anthropics
Guides users through a three-stage workflow to co-author documentation, proposals, specs and decision docs.
Writing Guidelines
vercel-labs
Reviews documentation and prose against fetched Writing Guidelines and reports style findings.
Job Post Builder
anthropics
Builds a hiring packet — job post, interview guide with rubrics, and offer letter template — from a role brief.
Write Spec
anthropics
Turns a feature idea or problem statement into a structured PRD with goals, user stories, requirements and metrics.
Draft Content
anthropics
Drafts marketing content such as blog posts, social posts, newsletters, landing pages, press releases and case studies.
Brand Voice Enforcement
anthropics
Applies existing brand voice guidelines to sales and marketing content, then explains the brand choices made.