softaworks/agent-toolkit / skills/crafting-effective-readmes
crafting-effective-readmes
VerifiedUse when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.
| File | Kind | Size |
|---|---|---|
| README.md | markdown | 6.0 KB |
| SKILL.md | skill md | 2.6 KB |
| references/art-of-readme.md | markdown | 23.9 KB |
| references/make-a-readme.md | markdown | 6.5 KB |
| references/standard-readme-example-maximal.md | markdown | 1.5 KB |
| references/standard-readme-example-minimal.md | markdown | 169 B |
| references/standard-readme-spec.md | markdown | 9.6 KB |
| section-checklist.md | markdown | 680 B |
| style-guide.md | markdown | 434 B |
| templates/internal.md | markdown | 1.9 KB |
| templates/oss.md | markdown | 1.6 KB |
| templates/personal.md | markdown | 1.1 KB |
| templates/xdg-config.md | markdown | 1.4 KB |
| using-references.md | markdown | 1.3 KB |
templates/xdg-config.md
View on GitHub# Config Directory README Template
Use this template for XDG config directories, dotfiles, script folders,
and any local directory you'll return to later wondering "what is this?"
The audience is future-you, probably confused.
---
# [Tool/Directory Name] Config
> Last reviewed: [YYYY-MM-DD]
[One sentence: what this directory configures and why you have custom config]
## What's Here
| Path | Purpose |
|------|---------|
| `[file-or-dir]` | [What it does] |
| `[file-or-dir]` | [What it does] |
| `[file-or-dir]` | [What it does] |
### [Subdirectory 1] (if complex enough to warrant detail)
[Brief explanation of what's in this subdirectory]
### [Subdirectory 2]
[Brief explanation]
## Why This Setup
[1-2 paragraphs explaining your philosophy or goals for this config. What problems were you solving? What workflow are you optimizing for?]
## How to Extend
### Adding a new [thing]
1. [Step 1]
2. [Step 2]
3. [Step 3]
### Adding a new [other thing]
1. [Steps]
## Dependencies
[What needs to be installed for this config to work]
```bash
[Install commands if applicable]
```
## Gotchas
- [Thing that will confuse future-you]
- [Non-obvious behavior]
- [Files that shouldn't be edited directly]
- [Order dependencies or load sequences]
## Sync/Backup
[How this config is backed up or synced across machines, if applicable]
## Related
- [Link to tool's official docs]
- [Link to your dotfiles repo if this is part of it]
- [Other relevant resources]
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 198k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |