GitLab Well Architected
Cookbook navigation
Prompts / Create Design System Documentation

Create Design System Documentation

Design & UXArchitectureDesignerDocumentationCreateBeginner

Document UI components with usage guidelines, props, and accessibility notes.

For GitLab Duo

prompt

Document our [COMPONENT/PATTERN]:

Implementation:
[PASTE CODE OR DESCRIBE]

Include:
1. Usage guidelines
2. Props/parameters
3. Visual examples
4. Do's and don'ts
5. Accessibility notes
6. Code examples

Use the prompt

Include the component's implementation and a few places where it's used. Those examples help explain the choices a developer makes when adopting it.