页面设计 对不同的人来说有不同的意思,但在这里它指的是您在专业设计的文档中看到的排版和格式使用。

我们在这里的重点是技术文档,这意味着简约、实用的设计。

有关您在这里看到的更详细信息,请参考这两个行业标准资源:

页眉和页脚

人们常常把标题和标题混淆。标题,涵盖在 标题 那些短语会出现吗 身体区域内 文档的标题是那些可能出现的短语和页码。 在标题区域内 文档的页脚是指出现在页面底部的短语和可能的页码。 在页脚区域内 文档的标题放在页眉区域是一个常见且严重的错误,这会导致标题出现在每一页的顶部。

查看典型文档页面的示意图:

Bottom of preceding page; top of following page

一种常见的页面设计是在页脚区域放置文档标题和页码。在交替格式中,左页可能按顺序显示页码和文档标题;右页可能按顺序显示文档标题和页码。

标题

以下是关于标题的一些标准指南。有关更详细的讨论,请参见章节内容。 标题 在在线教科书中。

列表

列表是强调重要点、快速浏览文本以及提供更多空白空间的有用工具。以下是一些关于列表的标准指南。欲了解更详细的讨论,请参见章节。 列表.

通知

通知是那些特殊格式的文本块,提醒读者注意特殊要点、例外、潜在问题或危险。以下列出了一些通知的标准指南。有关更详细的讨论,请参见章节。 通知.

数字

图形是各种插图、图画、示意图、照片等。请看 图形 进行详细讨论。同时,这里有一些重要要点:

表格

表格就像之前讨论的垂直列表,但更有结构和形式。在你的文本中,寻找可以格式化为表格的重复对、三元组或四元组项目。例如,一系列术语和定义是表格的经典用法。以下是一些表格的标准指南。有关更详细的讨论,请参见章节上的 表格.

突出显示

软件文档通常使用大量的突出显示。这里的突出显示是指粗体、斜体、不同的字体、大写字母、引号以及其他用于引起注意的排版技巧。以下是一些突出显示的标准指导原则。有关更详细的讨论,请参见章节。 突出显示.

边距、缩进与对齐

如标题部分所提到的,一个不错的做法是将正文缩进一到两英寸,同时将标题保持在左边缘。这种风格有两个好处:一是使标题更加突出,二是缩短了正文的行长度。

字体与颜色

关于字体和颜色,这里有一些建议:

我很想听听你对这一章的想法、反应和批评: 您的回复.