我们仍在处理这一章 -- 大卫

在本章中, 指的是非小说类技术文档—但不包括 用户指南,已在其他地方涵盖。 书籍设计 指的是非虚构技术文档的各种典型组成部分和元素的内容、风格、格式、设计和顺序。 组件 这里指的是书籍的实际部分或页面,如版次说明、序言、索引或封面和背面。 元素 指的是在非虚构技术文档中几乎可以多次出现的事物,例如标题、页眉、表格、插图、列表、通知、突出显示等。

本章开始于你可能想写一些扩展性和专业性的内容,但不是用户指南。你甚至可能有出版它的想法!它提供了印刷或PDF非小说技术书籍的典型组成部分和元素的概述,包括这些组成部分和元素的典型内容、格式、风格和顺序。

在你开始阅读以下内容之前,拿几本非小说类的技术书籍,以便你可以将它们的内容、风格、格式和排序与这里所讨论的进行比较。

封面和封底

非虚构技术书籍通常有精美设计的封面,封面上可能包含以下所有内容或某些内容:

这是一本2026年出版的Pragmatic Publishers关于人工智能工程的书籍示例:

Cover page example
封面示例。

硬拷贝用户指南和手册的背面通常很简单。通常,它包含书籍订单号码、公司名称及相应的商标符号、版权符号和关于书籍所有权的措辞,以及有关书籍印刷国家的声明。你还会在背面找到条形码。看看你的软件是否可以生成条形码—你只需访问条形码工具并输入书籍订单号码,该工具就会生成条形码。

标题页

标题页通常是封面的复制品,但包含艺术作品、颜色、公司或产品标志以及口号。在大多数图书设计中,标题页是书壳内的一张纸。有些技术出版物因为看似多余的重复而完全省略标题页。(而在一次印刷20,000本的情况下,一张纸的意义重大!)

Title page example
标题页示例。

版本公告

版次通知通常位于标题页的基本部分。如果技术出版商采用简约环保的方法并删除标题页,则版次通知将出现在前封面的背面。

没有人喜欢阅读细则,但请查看通常包含在版本通知中的声明。 一种常识性的人工智能工程方法, 一本实用程序员出版的书籍:

Edition notice example
版次通知示例

目录

目录(TOC)通常包含至少第二级的详细信息(实际文本中的头部 1),以便读者可以更准确地找到他们需要的内容。作者、编辑和书籍设计师通常会讨论目录的顺序。在可用性方面,最好将目录尽可能靠近书的前面,甚至放在书的最前面。然而,从法律角度来看,人们担心所有这些沟通声明、保修、版权、商标和安全通知应该放在前面。在那些可用性占优的地方,书籍会采用各种策略将这些法律材料从前言中移出:保修单放在单独的卡片上,与书籍或产品一起收缩包装;保修、沟通声明、商标等可以放在附录中。

TOC example
目录示例

创建格式良好的目录有困难吗?请查看 在 MSN Word 目录中对齐页码

图表清单

普通用户的技术手册通常没有图表列表。 实际上,图表本身通常也没有完整的图表标题。 但这并不是说图表列表在技术手册中没有用武之地。 这完全取决于读者及其需求—以及书籍的内容。 如果书中包含读者想要直接查找的表格、插图、图表、图形等,那么图表列表是必要的。

前言

序言的功能是让读者为阅读这本书做好准备。它通过以下方式实现:

在传统书籍出版中,前言在目录之前;但如前面讨论的那样, 目录 在技术出版领域,出版人员希望目录在书中尽早出现,以便于用户使用。

正文章节

哦,是的,这些书中确实有文字—并非全部是前言! 这里没什么好说的,除了大多数技术书籍都有章节或部分,在某些情况下还有分卷。 请参见章节关于 页面设计 格式、样式和设计问题,包括标题、页脚、标题、列表、通知、表格、图形、交叉引用和高亮显示等元素。

附录

如你所知,附录是用于那些似乎不适合放在书本主要部分但又无法从书中省略的材料。附录通常是放置大且难以处理的表格的地方。一些技术出版物在附录中包含保修条款。在格式上,附录就像一个章节,只是它被命名为"附录A"或类似的名称,并且页眉和页脚与这种不同的编号和命名约定相匹配(附录A中的页面为A-1、A-2,以此类推)。

词汇表

一些技术出版物包括专门术语及其定义的部分。请注意,大多数词汇表使用双列布局。通常每个术语及其定义构成一个独立的段落,术语小写(除非它是专有名词)并加粗,后面跟一个句号,然后是常规罗马体的定义。还要注意,定义通常不是完整的句子。好的词汇定义应使用正式句子定义技术,如所描述的。 定义章节 此在线文本。 多个定义通常用括号中的阿拉伯数字标识。 术语表段落也包含 首选术语的参考及 另请参见 相关术语的引用。

索引

索引通常也是两列的,并且还包含 对首选术语的参考和 另见 相关术语的参考。 请参阅关于 索引 用于创建良好索引的流程和指南。

书籍设计与排版

通常,硬件和软件制造商提供的用户指南和手册设计得相当简朴而简洁。高科技公司有时每九个月就会开发出新版本和新发布。在这种情况下,复杂的设计并不实用。以下是一些典型的布局和设计特点:

注意: 这结束了关于印刷书籍的讨论。 组件. 要完成关于印刷书籍设计的概述,请参阅章节有关 页面设计,覆盖 元素 例如页眉和页脚、标题、列表、特别通知、表格、图形、高亮、交叉引用等。

相关信息

阅读测验使用这个测验来测试你对本章的理解。

提供培训. 练习写作 麦克默里 作为你的老师。


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