Skip to content

Plugin README Checklist

Use this checklist to ensure every plugin README is accurate, comprehensive, and follows the current architecture standards.

Required Sections

  • Overview: High-level description of what the plugin does and its value proposition.
  • Quick Start: A clear list of commands that users can run immediately.
  • Architecture: A map of where commands, skills, and resources live within the plugin.
  • Dependencies: Required MCP servers, environment variables, and optional fallbacks.
  • Testing: Instructions for how to validate that the plugin is working correctly.
  • Versioning: Current version number and a brief summary of changes.

Accuracy Checks

  • Core Dependency: Explicitly mentions core-dependencies as the required operating layer.
  • Command Naming: Uses plain command names (e.g., /content-audit instead of /seo:content-audit).
  • Shared Standards: Verifies that no shared standards (tone, quality, etc.) are duplicated; they must be inherited from core-dependencies.
  • Link Verification: Points to the correct technical specifications:
    • docs/plugin-architecture.md for the current system design.
  • Archive Labeling: Any links to historical or reference material are correctly pathed to archive/... and clearly labeled as archived.

Terminology Cleanup

  • Remove all references to "V2" or "V3". Refer to the current system as the "Plugin Architecture".
  • Ensure "Skills" are used to describe behavior and mental models, rather than just "Personas".
  • Update any legacy links from docs/v2-*.md or docs/v3-*.md to the current docs/plugin-architecture.md.

Example Structure

# [Plugin Name]

[One-sentence overview]

## Quick Start
- `/command-1`: [Description]
- `/command-2`: [Description]

## Requirements
- Requires `core-dependencies` (v1.0.0+)
- Requires [MCP Server Name]

## Documentation
- [Link to Wiki Guide]
- [Link to Technical Spec]