跳到正文

文档三栏布局

Doc Layout

初级网页

文档三栏布局(Doc Layout)是把章节导航、正文和当前页目录分别放在左、中、右的页面布局。它让读者在阅读长篇产品文档或开发指南时,既能切换章节,也能快速找到当前页的具体内容。

你可能会说:「帮我把开发文档做成中间读内容、左边切章节、右边找当前页小节的页面。」

动手看看

章节:入门 / 接口 / 排错
概览:接入流程
安装:配置 SDK
鉴权:获取密钥
请求:发起调用
排错:常见问题
本页:概览 / 安装 / 鉴权
侧栏定位 position

这是开发指南常见的分工:左边切换章节,中间读正文,右边定位当前页内容。试着在演示区里滚动,再拖动页面宽度。

两侧目录用了 sticky,会在这个可滚动容器内停在顶部;中间的文档章节仍按正常顺序滚动。

要点

  1. 1

    左栏负责切换文档章节

    比如你在做 API 文档,左栏可以列出入门、认证和各类接口。读者看完认证想查某个接口时,能直接切换,不必退回文档首页重新找。

  2. 2

    中栏留给主要阅读内容

    正文放在中间,代码示例、说明和提示都随正文向下排列。因为读者主要是在这里阅读,所以两侧栏目不该挤到让代码和段落频繁换行。

  3. 3

    右栏定位当前页面小节

    右栏通常列出当前文章的标题,点击后跳到对应小节。它和左栏分工不同:左栏回答“还有哪些页面”,右栏回答“这一页讲到哪里”。窄屏时可以把两者收进菜单或改为折叠目录。

容易混淆的地方

它不等于左侧栏布局:左侧栏布局只规定侧边导航和主内容的关系,未必有右侧的当前页目录。它也不是分屏布局;分屏更强调两块内容并排查看或操作,而文档三栏布局始终以中间的阅读内容为主。

什么时候用

适合用

  • 做开发者文档时,章节多、单篇又长,读者需要在不同接口页面与页内参数说明之间来回查找。
  • 做产品帮助中心时,一篇操作指南包含多个步骤和常见问题,读者需要边读边定位具体小节。

不适合用

  • 只展示一篇很短的公告或说明时,没有多少章节可切换;用居中窄栏布局让人顺着读完就够了。
  • 做需要同时对照原文和译文的工作界面时,两边内容同样重要;用分屏布局比把一边当导航更合适。

练一练

你要为一个 AI 工具做开发文档:有多篇接入指南,每篇又有较长的步骤和代码示例。读者常要跨篇查找,也常要跳到当前页的某一步。你会选哪种布局?

让 AI 帮你做

请把这个开发文档页面做成文档三栏布局:左栏显示可切换的章节导航,中栏显示正文和代码示例,右栏显示当前页标题目录并能跳转。保持正文可读;在窄屏上收起两侧导航,让正文优先显示。

接下来学什么