pattern-documentation

Community

Document reusable UI patterns.

Authormurphytrueman
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: pattern-documentation
Download link: https://github.com/murphytrueman/design-system-ops/archive/main.zip#pattern-documentation

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.