readme-rubric

readme-rubric is a skill for Claude Code from alphabravo-oss/guild. It costs 89 tokens per session (2,441 once invoked), scanned A, a copy of readme-doctor, MIT.

A skill that reviews a GitHub repository’s README against practical documentation guidelines. A README is the main introductory document that explains a project and how to use it.

In plain words
What is it for?
Use it to audit a README, cite evidence with line numbers, and produce a prioritized list of improvements.
Why use it?
It finds unclear introductions, hard-to-follow setup instructions, stale information, and other documentation problems, then ranks the fixes.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin. Also seen: names the AskUserQuestion tool.

Part of the webster plugin — 11 skills, 6 agents shipped together

Good fit Use it to audit a README, cite evidence with line numbers, and produce a prioritized list of improvements.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/alphabravo-oss/guild/readme-rubric
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add alphabravo-oss/guild --skill readme-rubric
Clone the repo
git clone --depth 1 https://github.com/alphabravo-oss/guild

Made for: Claude Code.

Or install webster, the plugin that ships this one along with the rest of its 11 skills, 6 agents.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for readme-rubric

README.md
[![agentmods](https://agentmods.dev/badge/skills/alphabravo-oss/guild/readme-rubric.svg)](https://agentmods.dev/skills/alphabravo-oss/guild/readme-rubric)
Your own site
<a href="https://agentmods.dev/skills/alphabravo-oss/guild/readme-rubric"><img src="https://agentmods.dev/badge/skills/alphabravo-oss/guild/readme-rubric.svg" alt="Measured on agentmods" height="20"></a>
Per session 89 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,441 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin 94% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00089 $0.02441
Opus 5 $0.00044 $0.01221
Sonnet 5 $0.00018 $0.00488
Haiku 4.5 $0.00009 $0.00244

Measured 4d ago against content hash 58ef5dd82456, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

readme-rubric scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 4d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

94% identical to readme-doctor — 10 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

plugins/webster/skills/readme-rubric/SKILL.md · 194 lines

How it starts

The opening of the file, as written. The whole thing — 194 lines — stays where its author put it; the contents beside it link to each section on GitHub.

readme rubric

Most README problems aren't typos or missing sections — they're shape problems: the hero never lands, install-to-first-success buries the lede, the "what is this" sentence assumes prior context, the badge row is louder than the content. This skill audits a README against patterns that consistently correlate with maintainer outcomes (stars, contributor onboarding, issue quality) and produces a punch list a maintainer can act on in an afternoon.

The skill's quality comes from the rubric being grounded in the repo's actual audience and category, not from a generic checklist. A README for a 50K-star framework needs different things than a personal-project utility.

Phases

  1. Discovery — pick operating mode (Auto / Semi-auto / Manual, §1.1), input the README, infer the repo's category and audience from the scan, agree on what "good" looks like for this specific repo.
  2. Audit — walk the rubric, score each criterion, gather evidence (cite line numbers).
  3. Punch list — prioritize findings P0 (blocking) / P1 (high-leverage) / P2 (nice-to-have), each with a one-line fix.
  4. Optional output — read-only summary by default; on user request, open a PR with concrete edits.

Phase 1 — Discovery

1.1 Operating mode (ask first)

Three modes: Auto, Semi-auto (recommended), Manual. Use AskUserQuestion. Mode affects how many decisions are silent vs surfaced; it does not skip rubric checks.

1.2 Input

User may provide:

  • GitHub URLgh repo view + clone shallow
  • Local path → read directly
  • Pasted README text → analyze in place, but the rubric loses any check that needs file-tree context (manifest signals, screenshot presence, examples/ dir, etc.). Flag these as "skipped — paste-only mode."
  • Nothing → ask first

1.3 Scan (collect before judging)

  • README full text + rendered length (lines, words, time-to-scan estimate at 250wpm)
  • Manifest: package.json, Cargo.toml, pyproject.toml, etc. — version, description, keywords
  • File tree (depth 2): does an examples/ exist? docs/? Image assets?
  • Recent commits (last 10): is the repo active? When was last release?
  • GitHub signals: stars, topics, open issues count, latest release date

Read the full file on GitHub · 194 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 4d ago First seen · 194 lines · 89 tokens per session scan A 58ef5dd82456

Subscribe to this mod's changes

readme-rubric is a skill published in the GitHub repository alphabravo-oss/guild (2 stars, last pushed 6d ago), licensed MIT. It adds 89 tokens to every session and 2,441 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. It is 94% identical to readme-doctor, differing in 10 lines, and is treated as a copy.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens

next-partial-prefetching-adoption

Turn on Partial Prefetching in a Next.js app and work through the insights it surfaces. Use when the user wants to enable or adopt Partial Prefetching, flip the partialPrefetching flag, opt routes in with export const prefetch = 'partial', audit Link prefetch={true} behavior, preserve existing prefetched UI with…

vercel/next.js · 103 tokens

chronicle

Analyze Copilot session history for standup reports, usage tips, session search, and session reindexing. Use when the user asks for a standup, daily summary, usage tips, workflow recommendations, wants to search or find past sessions by keyword/file/PR, wants to reindex their session store, or asks about deleting…

microsoft/vscode · 72 tokens