dckc/mad-skills
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs-files-api: two sentences, then getting started, then features

Browse Source 
Generated-by: Claude Opus 5.5
This commit is contained in:
dckc committed 2026-10-09 01:25:13 -05:00
1 parent 522950dd6e
commit 349c6479e1
1 file changed
+4 -3
Download Patch File Download Diff File Expand all files Collapse all files
docs-files-api/SKILL.md
+4 -3
View File
@@ -7,14 +7,15 @@ description: Where docs go — README vs CONTRIBUTING vs AGENTS.md, and JSDoc pl
## README, CONTRIBUTING, AGENTS.md ## README, CONTRIBUTING, AGENTS.md
A **README** does two jobs, in this order: A **README** sells, then gets the reader running:
- **Marketing:** why should the reader care? What's cool about this? - **Up top, about two sentences:** what it is and why to care. Then
A few lines, not a feature matrix. straight to getting started.
- **Getting started:** get them to TADA! with no fuss. Readers skip to - **Getting started:** get them to TADA! with no fuss. Readers skip to
the first fenced block and copy it; if it doesn't work, boo. So that the first fenced block and copy it; if it doesn't work, boo. So that
block runs as-is from a fresh clone and ends with something to look block runs as-is from a fresh clone and ends with something to look
at (a URL, output). No architecture, no principles. at (a URL, output). No architecture, no principles.
- **After that:** features and benefits, as much as earns its place.
Everything else goes in **CONTRIBUTING**: design, layout of the code, Everything else goes in **CONTRIBUTING**: design, layout of the code,
how to test, conventions, deploying. how to test, conventions, deploying.