write-example-description

Write on-brand descriptions for PatternFly example components and demos.

10|26|Updated Jul 8, 2025
One-click install
npx skills add https://github.com/patternfly/ai-helpers --skill write-example-description
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-example-description
Source: https://github.com/patternfly/ai-helpers/tree/main/plugins/react/skills/write-example-description
Command: npx skills add https://github.com/patternfly/ai-helpers --skill write-example-description

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps PatternFly developers write and refine clear, on-brand descriptions for example components and demos on PatternFly.org, ensuring consistent tone and structure.

Core Features & Use Cases

  • Draft prose for component examples (under headings like ### Example name) and demos (under ## Demos / ### Demo name) so readers understand purpose and usage.
  • Align text with PatternFly MCP content guidelines, providing cross-links and tone guidance to improve accessibility and consistency.
  • Serve as a first-pass draft for writers, enabling quick reviews, edits, and publication readiness.

Quick Start

Ask me to draft or revise the description for a PatternFly example or demo.

Frequently Asked Questions about write-example-description

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

FAQPage Schema
How do I write descriptions for PatternFly component examples and demos?▼

To write PatternFly example descriptions, draft prose under component example headings and demo sections that explains purpose and usage. Descriptions must follow PatternFly MCP content guidelines for tone, structure, and cross-linking to ensure accessibility and consistency across PatternFly.org.

What is the correct structure for PatternFly demo descriptions on PatternFly.org?▼

PatternFly demo descriptions follow a structured format under ## Demos / ### Demo name headings. They align with PatternFly MCP content guidelines, ensuring clear prose that explains the demo's purpose and usage while maintaining consistent brand voice and accessibility considerations.

Can I use PatternFly brand voice guidelines to draft documentation for component examples?▼

Yes, you can draft documentation for component examples using PatternFly brand voice guidelines. The descriptions conform to PatternFly documentation standards and MCP guidelines, providing cross-links and tone guidance to improve accessibility and consistency for readers learning component usage.

What's the best way to ensure accessibility considerations in PatternFly documentation?▼

To ensure accessibility considerations in PatternFly documentation, apply MCP content guidelines during the description drafting process. This involves structuring prose for component examples and demos with consistent tone, cross-linking, and accessibility standards that conform to PatternFly documentation guidelines.

Does writing example descriptions require cross-linking to other PatternFly components?▼

Yes, writing example descriptions requires cross-linking to other PatternFly components. The process applies MCP guidelines for cross-linking and tone guidance, ensuring descriptions across PatternFly.org improve discoverability, learning, and consistency while conforming to documentation standards.