mikeparcewski/readme-style-guide
.claude/skills/readme-style-guide/SKILL.md
Canonical README template and validation rules for Wicked Garden marketplace plugins. Use when: "write a README", "plugin README template", "README structure", "marketplace README", "README style guide", "validate README"
$ install --global
skillsauthnpx skillsauth add mikeparcewski/wicked-garden readme-style-guideInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 16, 2026, 5:58 AM8.2s3 files scanned
SKILL.md
- name:
- readme-style-guide
- description:
- |
- Use when:
- write a README", "plugin README template", "README structure",
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:
- Install command
- First win (simplest useful command)
- 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?
Integration Table Format
Three columns are mandatory. The "Without It" column converts a dependency list into a value story.
| Plugin | What It Unlocks | Without It |
|--------|----------------|------------|
| wicked-mem | Decisions persist across sessions | Brainstorming works, but insights aren't stored |
Use active voice in "What It Unlocks" to imply directionality (who calls whom).
Conditional Section Triggers
| Section | Include When | |---------|-------------| | Lifecycle | Core value requires multiple invocations to see | | When to Use What | 3+ commands with overlapping scope | | How It Works | Internal mechanism is part of the value proposition | | Data API | Plugin exposes data via DomainStore or external integrations | | Agents & Skills | Merge tables if combined rows ≤5; split if either has 5+ |
Tone
- Confident, specific, technically precise
- Lead with "why" before "what"
- Every marketing claim backed by a concrete example or code block
- No hedging language ("might", "could potentially")
References
- Full annotated template:
refs/template.md - Validation rules and checklist:
refs/rules.md
Related Skills
mikeparcewski/wicked-garden-engineering-conformance-reviewer
development
VerifiedTrustedCommunity
Pattern-conformance agent-half: evaluates a produced artifact or diff against a set of architectural/design pattern rules from the conformance-rule store (wicked_governance schema). Returns structured findings with rule ID, severity, and rationale — the deterministic half (mechanical rule recall) is done by the guard pipeline; this is the semantic evaluation step. Triggered by: the guard_pipeline `outgov_pattern` check (session-close), or explicitly by an engineering review when WICKED_OUTGOV_RULES_DIR is populated. NOT a replacement for the full `engineering` review skill — focuses only on conformance to stored Pattern rules; architecture and code-quality checks live in the `engineering` skill. Semantic evaluation reuses `wicked-garden-qe-semantic-reviewer` as the designated agent-half evaluator (per garden#983 spec). This skill is the orchestrating wrapper that loads applicable Pattern rules and delegates the per-rule semantic judgment to qe-semantic-reviewer.
8SKILL.mdUpdated Jul 22, 2026
mikeparcewski/wicked-garden-domain
tools
VerifiedTrustedCommunity
The FOUNDATIONAL domain-model capability: extract a codebase's domain — testable business rules (with confidence + provenance), entities, requirements — as a schema-conformant model on the estate graph. The workers annotate the store; wicked-core reads it and builds the requirements graph, coverage-gating fail-closed. Steers three fork workers. A shared substrate, not a modernization tool. The `modernize` archetype DERIVES from it; build / migrate / review / specify / explore consume the SAME domain model — none OWN it. Understanding a codebase's domain is upstream of almost everything else garden does. Use when: "extract the business rules / domain model from this codebase", "build a requirements graph from the code", "what does this system actually require", "reverse-engineer the domain before we build/port/migrate". Works on ANY codebase (modern or legacy) — the value is the domain model, not the porting. NOT the code transform itself (that is the archetype consuming this model). This skill produces the DOMAIN MODEL, not new code.
8SKILL.mdUpdated Jul 15, 2026
mikeparcewski/wicked-garden-domain-modeler
development
VerifiedTrustedCommunity
Domain-graph fork worker for the modernize archetype. Groups the estate's Louvain communities into business domains, attaches each requirement to its cluster (advisory cluster_id provenance), and invokes wicked-core's domain-graph build (which reads the annotated estate store, recomputes coverage fail-closed, and builds the requirements graph) — then validates core's output against the vendored schema. Use when: dispatched by wicked-garden-domain after rule extraction to turn a flat rule set into cluster-keyed domains; "group these into domains", "build the requirements graph", "translate clusters into a domain model". NOT for mining the rules themselves (that is domain-extractor) or threat-modeling (that is domain-coverage).
8SKILL.mdUpdated Jul 15, 2026
mikeparcewski/wicked-garden-domain-extractor
tools
VerifiedTrustedCommunity
Rule-extraction fork worker for the FOUNDATIONAL domain-model capability. Mines testable business rules from a codebase — each with a numeric confidence and a provenance{source, ref, source_kinds} — and annotates them into the estate store so wicked-core can build the domain-model requirements graph (coverage-gated). This is a substrate, not a modernization tool: the `modernize` archetype DERIVES from it, and build / migrate / review / specify / explore can consume the same domain model — none OWN it. Use when: dispatched by wicked-garden-domain to mine the business_rules of a codebase (or a module); "extract the domain rules", "what does this system require", building the requirements half of a domain model. NOT for grouping into domains (that is domain-modeler) or judging coverage (that is domain-coverage — a seat-distinct evaluator).
8SKILL.mdUpdated Jul 15, 2026