readme-style-guide

readme-style-guide is a skill for Claude Code from mikeparcewski/wicked-garden. It costs 48 tokens per session (758 once invoked), scanned A, original, MIT.

A writing template and rule set for README files in Wicked Garden marketplace plugins.

In plain words
What is it for?
Use it to write or validate quick starts, workflows, command references, integrations, licenses, and skill or agent sections.
Why use it?
It gives plugin documentation a consistent structure and makes required sections easier to check.

Skill for Claude Code

Written for Claude Code: installed under .claude/. Also seen: mentions Claude Code.

Part of the wicked-garden plugin — 148 skills, 5 commands, 1 agent, 13 hooks shipped together

Good fit Use it to write or validate quick starts, workflows, command references, integrations, licenses, and skill or agent sections.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/mikeparcewski/wicked-garden/readme-style-guide
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 mikeparcewski/wicked-garden --skill readme-style-guide
Clone the repo
git clone --depth 1 https://github.com/mikeparcewski/wicked-garden

Made for: Claude Code.

Or install wicked-garden, the plugin that ships this one along with the rest of its 148 skills, 5 commands, 1 agent, 13 hooks.

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-style-guide

README.md
[![agentmods](https://agentmods.dev/badge/skills/mikeparcewski/wicked-garden/readme-style-guide/github.svg)](https://agentmods.dev/skills/mikeparcewski/wicked-garden/readme-style-guide)
Your own site
<a href="https://agentmods.dev/skills/mikeparcewski/wicked-garden/readme-style-guide"><img src="https://agentmods.dev/badge/skills/mikeparcewski/wicked-garden/readme-style-guide/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for readme-style-guide

Your own site · 80×15
<a href="https://agentmods.dev/skills/mikeparcewski/wicked-garden/readme-style-guide"><img src="https://agentmods.dev/badge/skills/mikeparcewski/wicked-garden/readme-style-guide.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 48 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 758 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. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
Origin original No closer match found 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.00048 $0.00758
Opus 5 $0.00024 $0.00379
Sonnet 5 $0.00010 $0.00152
Haiku 4.5 $0.00005 $0.00076

Measured 12d ago against content hash 51432317d157, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

readme-style-guide 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 12d 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.

.claude/skills/readme-style-guide/SKILL.md · 95 lines

How it starts

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

README Style Guide

Standard structure, tone, and content rules for Wicked Garden plugin READMEs.

Canonical Section Order

Every plugin README follows this structure. Sections marked CONDITIONAL include their trigger rule.

1.  # wicked-garden                           ← h1 + tagline (REQUIRED)
2.  ## {Lifecycle/Value Section}              ← CONDITIONAL: value invisible in single command
3.  ## Quick Start                            ← REQUIRED: 3 commands max
4.  ## {Core Workflows}                       ← REQUIRED: 2-3 real scenarios with output
5.  ## Commands                               ← REQUIRED: reference table
6.  ## When to Use What                       ← CONDITIONAL: 3+ commands with overlapping scope
7.  ## How It Works                           ← CONDITIONAL: mechanism is part of value prop
8.  ## Agents / Skills                        ← REQUIRED if plugin has agents or skills
9.  ## Data API                               ← CONDITIONAL: plugin exposes CP data sources
10. ## Integration                            ← REQUIRED: 3-column table
11. ## License                                ← REQUIRED

Tagline Rules

The first line after the h1 heading is the tagline. It must:

  • Be one sentence making a specific, differentiating claim
  • Name the behavior or outcome, NOT the category
  • Be falsifiable — a reader can verify whether it's true
GOOD: "Structural code intelligence across 73 languages — trace a JSP field to its database column."
BAD:  "A code search plugin for Claude Code."

GOOD: "Cross-session memory with signal-based recall and automatic decay."
BAD:  "A memory management plugin."

Quick Start Rules

Exactly 3 commands, labeled:

  1. Install command
  2. First win (simplest useful command)
  3. Most common use case

No prose explanations in Quick Start. That goes in Workflows or How It Works.

Workflow Section

Appears BEFORE the Commands reference table. Workflows persuade; Commands reference.

Each workflow: heading + code block (3-5 commands) + optional expected output block. Show real output when possible — what does the user actually see?

Read the full file on GitHub · 95 lines

Files

What ships with it

2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 12d ago First seen · 95 lines · 48 tokens per session scan A 51432317d157

Subscribe to this mod's changes

readme-style-guide is a skill published in the GitHub repository mikeparcewski/wicked-garden (9 stars, last pushed today), licensed MIT. It adds 48 tokens to every session and 758 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

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

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 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