Documentation Layout
Diseño de la documentación
Un Documentation Layout combina navegación, un artículo, ejemplos, su esquema y enlaces siguientes en una sola vista de lectura.
Otro ejemplo
Una guía de SDK muestra una navegación con versiones al lado de código y texto fácil de leer. Las pantallas anchas también muestran el esquema del artículo.
Partes principales
- 01Navegación del producto
- 02Cuerpo del artículo
- 03Esquema en la página
Úsalo cuando
Úsalo para guías o referencias vinculadas que las personas consultan en diferentes órdenes.
No lo uses cuando
No fuerces tres columnas ni dupliques menús en pantallas pequeñas. Mantén los ejemplos enlazables y fáciles de copiar.
Nombre usado en código
sidebar + main + in-page TOC + deep links Antes de lanzarlo
Check content order, shared design values, component consistency, contrast, zoom, and layout changes by screen size. Verify every theme, language, and state. If there is motion, offer an equal reduced-motion experience.
Outcome: Complete the task with Diseño de la documentación (Documentation Layout). User context: Una guía de SDK muestra una navegación con versiones al lado de código y texto fácil de leer. Las pantallas anchas también muestran el esquema del artículo. Design concept to apply: Diseño de la documentación (Documentation Layout). Why it fits: Úsalo para guías o referencias vinculadas que las personas consultan en diferentes órdenes. Do not use it when: No fuerces tres columnas ni dupliques menús en pantallas pequeñas. Mantén los ejemplos enlazables y fáciles de copiar. Design requirements: Set the content order, shared design values, and reusable components. Define how the layout changes by screen size and state. Keep useful design choices separate from decoration. Inclusion and resilience: Check contrast, zoom, languages, themes, and reduced motion when needed. Do not use color or effects as the only way to show meaning. Acceptance criteria: The design stays clear on phones and desktops, at zoom, in every theme, and in all supported languages. Interactive states stay clear and consistent. Evidence and limits (evidence boundary): Ningún estándar oficial único controla todo el término. Su significado puede cambiar según equipos, plataformas o marcos. Unknowns to confirm: Brand limits, amount of content, supported themes and languages, target devices, and design-system rules.
Revisa esta petición
Review how Diseño de la documentación (Documentation Layout) is used now. Definition: Un Documentation Layout combina navegación, un artículo, ejemplos, su esquema y enlaces siguientes en una sola vista de lectura. Release checks: Check content order, shared design values, component consistency, contrast, zoom, and layout changes by screen size. Verify every theme, language, and state. If there is motion, offer an equal reduced-motion experience. Before changing code, list the evidence, gaps, severity, and the smallest safe fix.