agentleFS
ShipfoxHQShipfoxHQ/shipfox/.agents/skills/readme-writer/SKILL.md

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

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.
  • CloudflareSkill

    security-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

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
  1. Distinctive:

    Use this workflow to document one package.

    line 9
  2. Distinctive:

    Before drafting a package README, read the package README standard.

    line 12
  3. Distinctive:

    When deciding whether detail belongs in the package README, read the engineering documentation map.

    line 17
  4. Distinctive:

    Read the public package surface in this order:

    line 23
  5. Distinctive:

    Do not document symbols that the package does not export or ship.

    line 31
  6. Distinctive:

    Use the inspected public contract for the package description, setup, and runnable usage example.

    line 37
  7. Distinctive:

    Check nearby package READMEs only for local conventions or comparable examples.

    line 40
  8. Very specific:

    Run mise exec -- turbo verify --filter=@shipfox/prose-policy and review its warnings and suggestions for the README.

    line 42

“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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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:

  1. package.json for its name, exports, binaries, scripts, and dependencies.
  2. The root export entry point for consumer-visible symbols.
  3. Additional source files only as needed to understand those exports.
  4. A sibling *-dto package when it owns public DTO or event names.
  5. drizzle/ or migrations/ when the package owns persistent data.

Do not document symbols that the package does not export or ship.

Workflow

  1. Apply the package README standard, including only the sections that fit the package.
  2. 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.
  3. Check nearby package READMEs only for local conventions or comparable examples. They do not override the shared standard.
  4. Run mise exec -- turbo verify --filter=@shipfox/prose-policy and review its warnings and suggestions for the README.
  5. Apply the guidance in WRITING.md to improve the result, then reread the README as a package consumer.

Report the public sources inspected, the sections included, and the prose-policy result.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.