布局与 CSS 深入了解 C · 行业惯例 平台: 网页

Documentation Layout

文档型布局

文档布局把导航、文章、示例、大纲和下一篇链接放在同一阅读页面。

看看怎样运作
也有人这样说 Documentation Layout说明文档布局参考文档框架Docs 版型

看看怎样运作

原创情境示例文档型布局

另一个例子

SDK 指南在代码和文字旁显示版本导航。宽屏也会显示文章大纲。

主要部分

  1. 01产品导航
  2. 02文章正文
  3. 03页内大纲

什么时候用

适合可按不同顺序阅读的系列指南或参考页。

什么时候不要用

小屏幕不要硬塞三列或重复菜单。示例要能链接,也要容易复制。

代码里的名称

sidebar + main + in-page TOC + deep links

上线前要检查

检查内容先后顺序、共用设计变量、组件一致性、对比度、缩放,以及页面能否随屏幕大小调整。验证每个主题、语言与状态;有动态效果时,也要提供同样完整的减少动态效果版本。

可以直接复制的需求

预期结果:定义或使用 文档型布局 (Documentation Layout),做出清楚、一致又好用的视觉体验。 用户场景:SDK 指南在代码和文字旁显示版本导航。宽屏也会显示文章大纲。 要运用的设计概念:文档型布局 (Documentation Layout)。 适用理由:适合可按不同顺序阅读的系列指南或参考页。 不应使用的情况:小屏幕不要硬塞三列或重复菜单。示例要能链接,也要容易复制。 设计要求:定义内容先后顺序、可复用的设计变量(Token)与组件。说明页面如何随屏幕大小和状态改变。分清必要的设计方向与纯装饰。 包容性与韧性:检查对比度、缩放、多语言、主题切换与减少动态效果。不能只靠颜色或特效表达含义。 验收标准:在手机、桌面、缩放、各种主题与所有支持语言中仍清晰可读。每个交互状态都一致且容易理解。 证据与限制(证据边界):没有一份官方标准能涵盖全部内容。不同团队、平台或框架的用法可能不同。 待确认:品牌限制、内容多少、支持的主题与语言、目标设备,以及现有设计系统规则。

检查这份需求

请 AI 编程助手检查当前如何使用 文档型布局 (Documentation Layout)。 定义:文档布局把导航、文章、示例、大纲和下一篇链接放在同一阅读页面。 生产环境检查:检查内容先后顺序、共用设计变量、组件一致性、对比度、缩放,以及页面能否随屏幕大小调整。验证每个主题、语言与状态;有动态效果时,也要提供同样完整的减少动态效果版本。 修改程序前,先列出看到的证据、缺口、严重程度,以及最小且安全的修正。

C
这个术语有多正式?

行业惯例

工作中经常会用到这个术语。列出的来源可能说明用法或限制,但不会定义全部内容。

没有一份官方标准能涵盖全部内容。不同团队、平台或框架的用法可能不同。

适用范围
没有单一正式文档涵盖全部内容
文档状态
不适用
核验日期
2026-07-30

证据来源与适用范围

背景资料没有单一权威定义工作中有人使用这个名称,但没有一份官方资料能定义全部内容。本页的解释和示例由 Vibulary 编写,供学习使用。

自行复制

浏览器无法自动复制。请选择下方文字,再自行复制。