Documentation Layout
Mise en page de la documentation
Un Documentation Layout combine la navigation, un article, des exemples, son plan et les liens suivants dans une seule vue pour lire.
Un autre exemple
Un guide SDK affiche une navigation versionnée à côté du code et du texte lisibles. Les grands écrans affichent aussi le plan de l'article.
Parties principales
- 01Navigation produit
- 02Corps de l'article
- 03Plan dans la page
Utilisez-le lorsque
Utilisez-le pour des guides ou références liés que les gens consultent dans des ordres différents.
Ne l'utilisez pas lorsque
Ne forcez pas trois colonnes ou des menus dupliqués sur les petits écrans. Gardez les exemples facilement liés et faciles à copier.
Nom utilisé dans le code
sidebar + main + in-page TOC + deep links Avant d'expédier
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 Mise en page de la documentation (Documentation Layout). User context: Un guide SDK affiche une navigation versionnée à côté du code et du texte lisibles. Les grands écrans affichent aussi le plan de l'article. Design concept to apply: Mise en page de la documentation (Documentation Layout). Why it fits: Utilisez-le pour des guides ou références liés que les gens consultent dans des ordres différents. Do not use it when: Ne forcez pas trois colonnes ou des menus dupliqués sur les petits écrans. Gardez les exemples facilement liés et faciles à copier. 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): Aucun standard officiel unique ne régit l’ensemble du terme. Sa signification peut varier selon les équipes, plateformes ou frameworks. Unknowns to confirm: Brand limits, amount of content, supported themes and languages, target devices, and design-system rules.
Vérifiez cette demande
Review how Mise en page de la documentation (Documentation Layout) is used now. Definition: Un Documentation Layout combine la navigation, un article, des exemples, son plan et les liens suivants dans une seule vue pour lire. 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.