skills.rest
mikeparcewski
mikeparcewskiCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

readme-style-guide

Validate Wicked Garden plugin READMEs against a canonical template and required sections.

8|2|Updated Feb 9, 2026
Search Tags:#template#documentation#validation#readme#plugin#style-guide
One-click install
npx skills add https://github.com/mikeparcewski/wicked-garden --skill readme-style-guide
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-style-guide
Source: https://github.com/mikeparcewski/wicked-garden/tree/main/.claude/skills/readme-style-guide
Command: npx skills add https://github.com/mikeparcewski/wicked-garden --skill readme-style-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides a canonical template and validation rules to ensure Wicked Garden plugin READMEs are consistent, scannable, and marketplace-ready.

Core Features & Use Cases

  • Enforces the standard README structure (title, Quick Start, Workflows, Commands, Integration, License) and ensures key sections are present.
  • Guides authors through best practices for tagline, tone, and active voice, with concrete examples and validation rules.
  • Helps teams quickly vet and publish plugin READMEs that meet quality thresholds for discovery and usage.

Quick Start

Write a compliant README following the canonical template and validation rules.

Frequently Asked Questions about readme-style-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate a README for inconsistent plugin documentation?▼

You validate a README by applying canonical template checks to ensure required sections like Quick Start, Workflows, and Integration are present, the integration table is valid, and no unresolved placeholders remain.

What sections are required in a canonical plugin README style guide?▼

Required sections in a canonical plugin README include the title, tagline, Quick Start, Workflows, Commands, Integration, and License to ensure the documentation is scannable and marketplace-ready.

How do I ensure my plugin documentation meets marketplace-ready quality thresholds?▼

Ensure documentation meets marketplace-ready thresholds by following style guide validation rules that check for required sections, a valid integration table, accessible guidance, and active voice.

Can I use this style guide to vet plugin READMEs as a reviewer?▼

Yes, teams can use this style guide validation to vet plugin READMEs by checking for required sections, valid integration tables, and the absence of unresolved placeholders before publication.

Why does my README validation fail on unresolved placeholders?▼

README validation fails on unresolved placeholders because the canonical style guide requires all template fields to be fully populated, ensuring the plugin documentation is complete and marketplace-ready.

Related Skills

Explore More Content & Communication Skills→
ZenterFlowZenterFlow
2

plugin-formatter

Format Claude Code plugin structures and metadata to marketplace guidelines.

Community
Intermediate
agentglassagentglass
1

deploy

Deploys documentation sites to Netlify or Vercel and updates the plugin marketplace registry.

Official
Intermediate
microwindmicrowind
65

JSON验证器

Validate and format JSON data with syntax, structural, and optional schema checks.

Official
Advanced
cuiosscuioss
4

ext-triage-plugin

Triage marketplace plugin findings from pytest, plugin-doctor, markdownlint, and yamllint during plan-finalize.

Official
Intermediate