readme-writer
Skill87 starsChanged 13 days agoMITView on GitHub
Use this skill to write or revise a README.md for a Shipfox workspace package (libs/*, tools/*). It applies the shared package README standard and repository prose policy. Trigger on write a README, draft README, rewrite README, document this package, or improve the README.
25 other projects use a version of this.
Adopted by
Most recently taken up by
- Kuan-AI-com/agent-skillstheir own version, first seen Nov 15, 2026
- sandrinodm/skillstheir own version, first seen Nov 8, 2026
- vigneshm1995personal/skillgatetheir own version, first seen Nov 8, 2026
- andymartinezot/claude-skillstheir own version, first seen Nov 1, 2026
- nseney1/Soma-Governancetheir own version, first seen Nov 1, 2026
- OneByJorah/VirtOfficetheir own version, first seen Nov 1, 2026
Used with
Projects with it also use security-audit.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
CloudflareSkillsecurity-audit
Security guidance and vulnerability review for codebases, APIs, services, CLI tools, libraries, and daemons. Use for security questions, focused reviews, vulnerability research, security audits, or pen tests. Run the complete workflow only for explicit codebase audit or pen-test requests, full/comprehensive/end-to-end reviews, or requested report artifacts.
Also in 3 projects that use this
Other versions25 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 25
- event-driven-io/emmett★ 562same name
- OneByJorah/offivo★ 24same name
- OneByJorah/VirtOffice★ 24same name
- sandrinodm/skills★ 11same name
- nseney1/Aegis-Guardrails★ 4same name
- nseney1/Soma-Governance★ 4same name
- shimo4228/claude-harness★ 4same name
- WST2002/claude-code-skills★ 4same name
- guihai24/openskills★ 2same name
- IdkwhatImD0ing/hackathonstarterkit★ 2same name
15 more not listed
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 repository11 other files it gives its agents.
- AGENTS.mdAGENTS.md
- address-pr-commentsSkill
- commitSkill
- fix-ciSkill
- generate-changesetSkill
- impeccableSkill
- implement-issueSkill
- prSkill
- shipSkill
- impeccableSkill
- impeccableSkill
The file
We split this skill into the rules it gives an agent
8 rules. 0 are common, 7 are distinctive, and 1 is very specific to this project.
0
Common
Most of the 20 edited versions we read keep these.
7
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 9
Use this workflow to document one package.
- Distinctive: line 12
Before drafting a package README, read the package README standard.
- Distinctive: line 17
When deciding whether detail belongs in the package README, read the engineering documentation map.
- Distinctive: line 23
Read the public package surface in this order:
- Distinctive: line 31
Do not document symbols that the package does not export or ship.
- Distinctive: line 37
Use the inspected public contract for the package description, setup, and runnable usage example.
- Distinctive: line 40
Check nearby package READMEs only for local conventions or comparable examples.
- Very specific: line 42
Run mise exec -- turbo verify --filter=@shipfox/prose-policy and review its warnings and suggestions for the README.
“Common” is measured: kept by at least 6 in 10 of the 20 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
README Writer
Use this workflow to document one package. It does not apply to the repository root README, design documents, or RFCs.
Before drafting a package README, read the package README standard. It owns the required structure, prose style, public-surface rules, development guidance, and license section for human and agent authors.
When deciding whether detail belongs in the package README, read the engineering documentation map. It owns documentation placement and canonical ownership.
Gather the package contract
Read the public package surface in this order:
package.jsonfor its name, exports, binaries, scripts, and dependencies.- The root export entry point for consumer-visible symbols.
- Additional source files only as needed to understand those exports.
- A sibling
*-dtopackage when it owns public DTO or event names. drizzle/ormigrations/when the package owns persistent data.
Do not document symbols that the package does not export or ship.
Workflow
- Apply the package README standard, including only the sections that fit the package.
- Use the inspected public contract for the package description, setup, and runnable usage example. Link to schemas or configuration sources instead of copying fast-changing values.
- Check nearby package READMEs only for local conventions or comparable examples. They do not override the shared standard.
- Run
mise exec -- turbo verify --filter=@shipfox/prose-policyand review its warnings and suggestions for the README. - Apply the guidance in
WRITING.mdto improve the result, then reread the README as a package consumer.
Report the public sources inspected, the sections included, and the prose-policy result.
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.

