agentleFS
g4br13lg4br13l/ai-personal-tools/.agents/skills/crafting-effective-readmes/SKILL.md

crafting-effective-readmes

Skill2 starsChanged 6 months agoNo licenceView on GitHub

Guides writing or improving README files by audience and project type, including optional code-style and architecture sections. Use when creating READMEs, updating docs, or when the user asks for readme structure, project documentation, or contributor onboarding.

  • Reads credentials

14 other projects use a version of this, 14 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use feedback-mastery, skill-judge and 6 more.

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

    feedback-mastery

    Use when preparing to give difficult feedback, approaching a hard conversation with a direct report, peer, or manager, or navigating conflict at work. Also use before performance reviews or when addressing repeated behavior issues. Keywords: give feedback, hard conversation, conflict, performance issue, SBI framework.

    Also in 3 projects that use this

  • wpankSkill

    skill-judge

    Evaluate Agent Skill quality against official specifications. Use when reviewing SKILL.md files, auditing skill packages, improving skill design, or checking if a skill follows best practices. Provides 8-dimension scoring (120 points) with actionable improvements. Triggers on review skill, evaluate skill, audit skill, improve skill, skill quality, SKILL.md review.

    Also in 3 projects that use this

  • jeasonstudioSkill

    agent-md-refactor

    Refactor bloated AGENTS.md, CLAUDE.md, or similar agent instruction files to follow progressive disclosure principles. Splits monolithic files into organized, linked documentation.

    Also in 3 projects that use this

  • jamesrochabrunSkill

    qa-test-planner

    Generate comprehensive test plans, manual test cases, regression test suites, and bug reports for QA engineers. Includes Figma MCP integration for design validation.

    Also in 3 projects that use this

  • nahisahoSkill

    database-schema-designer

    Copilot agent for database schema design, ER diagrams, normalization, DDL generation, and performance optimization

    Also in 3 projects that use this

  • lookfreeSkill

    excalidraw

    Generate architecture diagrams as .excalidraw files from codebase analysis. Use when the user asks to create architecture diagrams, system diagrams, visualize codebase structure, or generate excalidraw files.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

10 rules. 5 are common, 2 are distinctive, and 3 are very specific to this project.

  • 5

    Common

    Most of the 14 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

No licence file, so all rights are reserved — read it at the source. We count its rules but don't quote them. Read them on GitHub.

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

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.