pattern-documentation

Generate structured design system pattern documentation covering scope, composition, states, and accessibility.

155|7|Updated Mar 9, 2026
One-click install
npx skills add https://github.com/murphytrueman/design-system-ops --skill pattern-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pattern-documentation
Source: https://github.com/murphytrueman/design-system-ops/tree/main/skills/pattern-documentation
Command: npx skills add https://github.com/murphytrueman/design-system-ops --skill pattern-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the common issue of under-documented design system patterns, which leads to inconsistent implementation and knowledge loss. It provides a structured approach to creating comprehensive pattern documentation.

Core Features & Use Cases

  • Pattern Identification: Guides users on how to identify if a UI solution qualifies as a documentable pattern.
  • Structured Documentation: Provides a template for documenting pattern scope, usage, composition, states, accessibility, and anti-patterns.
  • Use Case: A design system team needs to document a new "empty state" pattern that is composed of an illustration, a heading, and a call-to-action button. This Skill will guide them through creating a page that explains when to use it, how to compose it, and its accessibility considerations.

Quick Start

Use the pattern-documentation skill to write documentation for a new form validation pattern.

Frequently Asked Questions about pattern-documentation

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

FAQPage Schema
What is design system pattern documentation and how does it differ from component docs?

Design system pattern documentation defines reusable UI solutions composed of multiple components, whereas component docs cover individual elements. It outlines pattern scope, composition, state management, and accessibility to prevent inconsistent implementation and system drift.

How do I document a UI pattern for an empty state or form validation?

To document a UI pattern, identify its scope, composition, states, accessibility, and anti-patterns. Use a structured template to explain when to use the pattern, how its components compose together, and what behaviors to avoid for consistent implementation.

When should I create pattern documentation instead of just documenting components?

You should create pattern documentation when a UI solution qualifies as a reusable composition of multiple components, such as an empty state with an illustration and call-to-action. Documenting patterns separately prevents knowledge loss and reduces design system drift.

What should be included in accessibility guidelines for design system patterns?

Accessibility guidelines for design system patterns should cover how composed components interact with assistive technologies, manage focus states, and handle semantic markup. Documenting these considerations ensures designers and developers implement inclusive and consistent UI solutions.

Does pattern documentation help prevent design system drift across teams?

Yes, pattern documentation prevents design system drift by providing a structured reference for pattern scope, composition, and anti-patterns. This clarity ensures designers and developers implement UI solutions consistently, reducing knowledge loss and fragmented design choices.

What are anti-patterns and why document them for UI patterns?

Anti-patterns document incorrect usage of a UI pattern, clarifying what to avoid during implementation. Including anti-patterns in design system documentation helps developers recognize improper component composition and state management, ensuring consistent pattern usage across products.