agentleFS
Sign inStart free
zhoux77899zhoux77899/flawless/skills/readme-writing/SKILL.md

readme-writing

Skill1 starsChanged 6 months agoMITView on GitHub

Creates or improves repository README files using repository analysis, type-specific README patterns, and optional agent-facing guidance. Use when the user asks to write, rewrite, audit, or upgrade README.md documentation for libraries, frameworks, CLIs, applications, AI/ML projects, datasets, DevOps tools, infrastructure projects, SDKs, templates, agent plugins, or documentation repositories.

7 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions7 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 7

    1. codetesla51/skills★ 32same name
    2. Charlyhno-eng/jev-codex-pilot★ 7same name
    3. KhaledSaeed18/dotclaude★ 5same name
    4. indubitably-ai/indubitably-skills★ 1same name
    5. Jannchie/skills★ 1same name
    6. yiweiwan/skills★ 1same name
    7. luxiangze/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.

The file

We split this skill into the rules it gives an agent

12 rules. 0 are common, 4 are distinctive, and 8 are very specific to this project.

  • 0

    Common

    Most of the 5 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 8

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Write README files from repository facts, not generic templates.

    line 10
  2. Very specific:

    After running repository analysis, read references/index.md to map repo_type to the right guide and optional research file.

    line 16
  3. Distinctive:

    Treat the output as a draftable fact sheet.

    line 38
  4. Very specific:

    Read references/index.md for the repo-type guide and research mapping.

    line 40
  5. Very specific:

    Read the repo-type reference matching repo_type.

    line 42
  6. Very specific:

    Read the mapped references/research/*.md only when examples or anti-patterns would improve the draft.

    line 43
  7. Very specific:

    Use agent_content_strategy: omit means no agent section, link-to-agent-doc means link to existing AGENTS.md or CLAUDE.md, and inline means …

    line 46
  8. Very specific:

    Run python skills/readme-writing/scripts/validate_readme.py <repo> --analysis <analysis.json> when you have a README draft saved.

    line 47
  9. Very specific:

    Never force For Human or For Agents headings.

    line 52
  10. Very specific:

    Prefer commands from command_details when inferred is false.

    line 53
  11. Distinctive:

    Keep the first screen concrete: project name, value, audience, and the fastest useful action.

    line 54
  12. Distinctive:

    Do not copy researched README prose.

    line 56

“Common” is measured: kept by at least 6 in 10 of the 5 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 Writing

Overview

Write README files from repository facts, not generic templates. Use the bundled scripts to create a stable analysis, then load only the reference files needed for the detected repository type.

Agent-facing content is optional. Decide whether to inline it, link to an agent doc, or omit it using references/audience-policy.md and the script's agent_content_strategy.

Reference Map

After running repository analysis, read references/index.md to map repo_type to the right guide and optional research file. Then load the minimum set needed:

  • Agent policy: references/audience-policy.md
  • Libraries and SDKs: references/repo-types/libraries-sdks.md
  • CLI and developer tools: references/repo-types/cli-devtools.md
  • Applications and UI: references/repo-types/apps-ui.md
  • AI/ML, data, and benchmarks: references/repo-types/ai-ml-data.md
  • Infrastructure and DevOps: references/repo-types/infra-devops.md
  • Documentation, learning, and awesome lists: references/repo-types/docs-learning.md
  • Plugins and agent skills: references/repo-types/plugins-agent-skills.md
  • Security, privacy, and protocols: references/repo-types/security-protocols.md
  • Fallback/general repositories: references/repo-types/general.md

Dependencies

  • scripts/analyze_repo.py and scripts/validate_readme.py use only the Python standard library. Run them with Python 3.10+.

Workflow

  1. Analyze the repository:
    • Run python skills/readme-writing/scripts/analyze_repo.py <repo> --format json --output <analysis.json>.
    • For a human-readable starting point, run python skills/readme-writing/scripts/analyze_repo.py <repo> --format markdown-outline --output <analysis-outline.md>.
    • Treat the output as a draftable fact sheet. Do not commit generated analysis files unless the user asks.
  2. Load references:
    • Read references/index.md for the repo-type guide and research mapping.
    • Read references/audience-policy.md.
    • Read the repo-type reference matching repo_type; read a second type only for true hybrids such as CLI plus library or AI app plus dataset.
    • Read the mapped references/research/*.md only when examples or anti-patterns would improve the draft.
  3. Draft and validate:
    • Build a natural README structure from the repo-type reference and the analysis output.
    • Use agent_content_strategy: omit means no agent section, link-to-agent-doc means link to existing AGENTS.md or CLAUDE.md, and inline means include concise agent-oriented usage or compatibility notes.
    • Run python skills/readme-writing/scripts/validate_readme.py <repo> --analysis <analysis.json> when you have a README draft saved.
    • Fix reported issues or explain any intentionally accepted warning.

Quality Rules

  • Never force For Human or For Agents headings. Use them only when they fit the repo and user request.
  • Prefer commands from command_details when inferred is false; label inferred commands explicitly, with the marker source matching command_details.source or command_details.evidence.
  • Keep the first screen concrete: project name, value, audience, and the fastest useful action.
  • Link to deeper docs instead of duplicating mature documentation.
  • Do not copy researched README prose. Use references for patterns, not source text.
  • Omit unsupported badges, benchmarks, install commands, guarantees, and roadmap claims.

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.

Check your setup, free