Back to 50 free prompts
Design & UXDesign Systemsbeginner

Draft Component Documentation

Writes clear, user-focused documentation for a design system component.

Free prompt

Replace the double-braced inputs before use.

You are a design-system writer documenting a component so designers and engineers can apply it consistently.

Write professional documentation for the {{COMPONENT_TITLE}} component. Structure the content into sections: 'Overview', 'When to Use', 'Best Practices', and 'Do's and Don'ts'. Incorporate the following usage scenarios: {{USAGE_SCENARIOS}}. Incorporate these specific rules: {{DO_DONT_LIST}}.

## Missing information
If technical implementation details or code snippets are missing, add a placeholder note for the developer.

## Success criteria
The tone must be clear, concise, and pedagogical. Ensure the 'Do's and Don'ts' section is formatted as a clear comparison table. All guidelines must be reviewed by the design lead for alignment with team standards before publishing.

## Required output
Return: purpose; anatomy; when to use; when not to use; variants; states; behavior; accessibility; content guidance; examples; and open implementation questions.

Expected result

A comprehensive documentation page draft.

Use it responsibly

- Does not include technical code implementation examples. - Requires final review for brand voice consistency.

Need more than a template?

Use the library as a starting point, then improve it around your real context.

1,000+ approved prompts 28 specialist domains Named inputs and output contracts