Skip to main content

document-a-ui-component

Document a UI component's purpose, anatomy, behavior, states, content, accessibility, and implementation contract. Use when designers and engineers need one practical source for correct reuse.

Datos de origen

Repositorio
protosphinx/sphinxstack
Última actividad en el origen
29 de julio de 2026 a las 13:55
Idioma detectado de SKILL.md
inglés
Estrellas
3
Forks
0

Opciones de instalación

De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.

Revisa los archivos de origen

Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.

Explorador de archivos
2 archivos

Mostrando SKILL.md

SKILL.md
Instrucciones de origen · Vista previa de solo lectura
name
document-a-ui-component
category
design
description
Document a UI component's purpose, anatomy, behavior, states, content, accessibility, and implementation contract. Use when designers and engineers need one practical source for correct reuse.
# document-a-ui-component Show how the component behaves under real content and interaction, not only how it looks at rest. ## Procedure 1. State the user problem, intended use, non-use cases, owner, and maturity. 2. Label anatomy, slots, variants, properties, events, and composition rules. 3. Cover default, hover, focus, active, selected, loading, empty, error, disabled, and overflow states. 4. Define keyboard, focus, semantics, announcements, contrast, and motion behavior. 5. Provide content rules for labels, help, validation, localization, and truncation. 6. Include responsive, theming, density, and platform behavior. 7. Add runnable examples, counterexamples, API notes, and migration guidance. 8. Verify documentation against the shipped component and tests. ## Guardrails - Do not document a state the implementation cannot produce reliably. - Avoid examples that use inaccessible placeholder content. - Separate stable contract from experimental guidance. ## Done - A component documentation page covers anatomy, states, behavior, and usage - Examples and accessibility behavior are tested against implementation - Design and engineering owners verify the documented contract
Ver en GitHub