Documentation Layout
Layout da documentação
Uma Documentation Layout combina navegação, um artigo, exemplos, seu outline e os próximos links em uma única tela de leitura.
Outro exemplo
Um guia de SDK mostra uma navegação com versão ao lado de código e texto fáceis de ler. Telas largas também mostram o índice do artigo.
Partes principais
- 01Navegação do Produto
- 02Corpo do artigo
- 03Esboço na página
Use-o quando
Use-o para guias ou referências vinculadas que as pessoas exploram em diferentes ordens.
Não o use quando
Não force três colunas ou menus duplicados em telas pequenas. Mantenha os exemplos vinculáveis e fáceis de copiar.
Nome usado no código
sidebar + main + in-page TOC + deep links Antes de lançar
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 Layout da documentação (Documentation Layout). User context: Um guia de SDK mostra uma navegação com versão ao lado de código e texto fáceis de ler. Telas largas também mostram o índice do artigo. Design concept to apply: Layout da documentação (Documentation Layout). Why it fits: Use-o para guias ou referências vinculadas que as pessoas exploram em diferentes ordens. Do not use it when: Não force três colunas ou menus duplicados em telas pequenas. Mantenha os exemplos vinculáveis e fáceis 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): Nenhum padrão oficial único controla todo o termo. Seu significado pode mudar entre equipes, plataformas ou frameworks. Unknowns to confirm: Brand limits, amount of content, supported themes and languages, target devices, and design-system rules.
Conferir este pedido
Review how Layout da documentação (Documentation Layout) is used now. Definition: Uma Documentation Layout combina navegação, um artigo, exemplos, seu outline e os próximos links em uma única tela de leitura. 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.