readme-docs
Skill5 starsChanged 21 days agoMITView on GitHub
Create or refresh a distinctive, evidence-backed `README.md` landing page for newcomers. Use when a README is missing, thin, generic, stale, or hard to navigate. Covers purpose, audience, first success, proof, examples, and documentation routes.
1 other project uses a version of this.
Adopted by
Most recently taken up by
- gandolh/my-personal-skillstheir own version, first seen Oct 17, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 1
- gandolh/my-personal-skills★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository47 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- agents-md-fixerSkill
- arch-docsSkill
- book-to-markdownSkill
- docset-updaterSkill
- humanizerSkill
- news-release-docsSkill
- pdf-guideSkill
- screenshot-docsSkill
- see-also-docsSkill
- setup-install-usage-docsSkill
- bptools-writer-expertSkill
- color-accessibility-expertSkill
- css-creative-expertSkill
- game-design-expertSkill
- geometry-expertSkill
- glass-expertSkill
- hic-human-interact-expertSkill
- openscad-3d-printing-expertSkill
- podman-expertSkill
- postgresql-expertSkill
- pyside6-engineerSkill
- rust-code-expertSkill
- solid-js-expertSkill
- svg-creator-expertSkill
- typescript-engineerSkill
- ui-ux-engineerSkill
- vision-expertSkill
- wasm-rust-expertSkill
- webwork-writer-expertSkill
- delegate-manager-to-subagentsSkill
- gas-town-workflowSkill
- hang-checkSkill
- html-game-parallel-builderSkill
- parallel-planSkill
- stay-busySkill
- repo-rules-readerSkill
- blueprint-plan-drafterSkill
- ideonomy-plainSkill
- ideonomy-richSkill
- make-goalSkill
- modest-plan-drafterSkill
- audit-code-reviewerSkill
- old-python-code-reviewSkill
- prune-testsSkill
- unit-test-starterSkill
The file
We split this skill into the rules it gives an agent
9 rules. About 0 are common, 5 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 16
Start from assets/README_TEMPLATE.md for a missing, thin, or structurally failed README.
- Very specific: line 18
Read references/readme_best_practices.md when project type or section choice is unclear.
- Very specific: line 20
Read references/landing_page_ideas.md when the page needs a stronger signature promise or proof treatment.
- Distinctive: line 31
Use one H1 for the project name, followed by a plain-prose opening paragraph of at most 250 characters.
- Distinctive: line 45
Read operative repository rules, the current README, core docs, manifests, executable front doors, examples, tests, screenshots, …
- Distinctive: line 52
Write a project-specific opening and choose a live demo, screenshot, output sample, compact transformation, architecture visual, or worked …
- Distinctive: line 54
Verify every command that is safe and practical.
- Very specific: line 61
When the project has a visual interface/output or the user requests screenshots, include this exact empty block for screenshot-docs:
- Distinctive: line 77
Keep the value proposition, primary onboarding path, representative example, and navigation context in README.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
README landing page
Purpose
Make README.md a useful front door: establish identity, audience, value, proof, first success, and
deeper documentation routes in the order a newcomer needs them. This skill owns README content;
specialized documentation skills own their files under docs/.
Route supporting resources
- Start from
assets/README_TEMPLATE.mdfor a missing, thin, or structurally failed README. - Read
references/readme_best_practices.mdwhen project type or section choice is unclear. - Read
references/landing_page_ideas.mdwhen the page needs a stronger signature promise or proof treatment. - Apply
references/review_checklist.mdfor broad refreshes and final landing-page audits. - Apply
references/scoring_rubric.mdfor explicit scoring, before/after comparison, or a broad refresh.
Resolve every template placeholder before delivery.
Landing-page contract
- Use one H1 for the project name, followed by a plain-prose opening paragraph of at most 250 characters. State purpose, audience or use case, main benefit, and a distinguishing detail when space allows. Put links, badges, code, URLs, and setup after that paragraph.
- Establish purpose and the strongest available proof before
Quick start. - Give a verified install/run path that reaches a meaningful result, plus one representative example and expected behavior when useful.
- Summarize three to six concrete capabilities or outcomes and curate three to eight primary documentation routes before grouping a larger docset.
- Include supported status, limitations, prerequisites, platforms, help, license, citation, or contributor routes only when repository evidence makes them useful.
- Preserve current explanations, examples, visuals, warnings, and credits that remain accurate.
Workflow
- Read operative repository rules, the current README, core docs, manifests, executable front doors, examples, tests, screenshots, release/deployment evidence, and license files.
- Derive the project name, audience, primary value, project type, first-success path, strongest proof, and adoption constraints from current evidence.
- For a broad refresh, score the current page and identify the two highest-value improvements.
- Design the newcomer journey: identity and value, proof, first success, representative use, deeper routes, then secondary adoption context.
- Write a project-specific opening and choose a live demo, screenshot, output sample, compact transformation, architecture visual, or worked scenario that proves the signature promise.
- Verify every command that is safe and practical. Match paths, claims, live links, deployment URLs, status, and license wording to repository evidence.
- Apply the routed review checklist, repository Markdown/ASCII checks, and
tests/test_readme_first_paragraph.pywhen present. Re-score broad refreshes.
Managed visuals
When the project has a visual interface/output or the user requests screenshots, include this exact
empty block for screenshot-docs:
<!-- screenshots:begin (managed by screenshot-docs) -->
<!-- screenshots:end -->This skill owns surrounding prose and the sentinel lines. screenshot-docs owns capture,
docs/screenshots/, alt text, embed syntax, and the content between sentinels.
For a browser app, place a confirmed live link near the opening. Use a configured URL; derive a Pages URL only when deployment evidence confirms it.
Content boundary
Keep the value proposition, primary onboarding path, representative example, and navigation context in README. Route exhaustive APIs, configuration, architecture, troubleshooting, and maintainer process to their owning docs. Turn substantive missing docs and remaining landing-page opportunities into bounded follow-ups with an owner, target, evidence, success criteria, and verification.
Completion
Return the updated README, commands and links checked, unresolved claim status, and routed doc gaps. For broad refreshes, include before/after scoring and the strongest gain. Finish only when the quick start reaches a real result, the page carries project-specific proof when applicable, all placeholders are resolved, and current valuable content remains discoverable.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

