请点击这里以提供帮助 大卫·麦克梅里 支付网站托管费用：
捐赠您能提供的任何小额款项
在线技术写作将继续免费。
此页面正在维护。
一个 用户指南 是一本技术文档，解释了产品用户如何执行常见任务。常见 任务 是用户需要能够执行的那些操作。 用户 处于产品所期望的知识和经验水平。一些产品有基础用户和高级用户—用户指南可以满足其中一个或两个需求。想想微波炉：它可以有一个基础用户，仅此而已。另一方面，图形设计产品可以同时拥有基础用户和高级用户。
NotebookLLM 生成的本章信息图表
在这一章， 书籍设计 意味着书籍各种典型组成部分的内容、风格、格式、设计和顺序。“组成部分”在这里指的是书籍的实际部分或页面，如版次公告、前言、索引或封面和封底。在 页面设计 章节，术语 元素 指的是可以在书中几乎任何地方多次出现的事物，例如页眉、页脚、表格、插图、列表、通知、突出显示等。
以下提供了一本印刷技术书籍典型组成部分的概述，以及这些组成部分的典型内容、格式、风格和顺序。当然，实际上没有任何一本用户指南、技术参考手册、快速参考文件或其他类似文档会具备所有这些组件，并以您即将阅读的方式进行设计和排列。相反，这个概述将提供可能性的概览——我们可以说是可能性的范围。
注意： 目前，我们只有示例。 用户指南 在 FrameMaker 中开发，然后输出为 PDF。它缺少词汇表，但典型用户指南的其他部分都已到位。(我无法弄明白“Filepad”中的“d”是什么！) 请注意，它不符合以下列出的一些字体和边距要求。
在你开始阅读以下内容之前，拿几本硬件和软件的书，以便你能够将它们的内容、风格、格式和顺序与这里讨论的内容进行比较。
如需比这里看到的更详细的信息，请查阅这两个行业标准资源：
- 太阳技术出版物。 请先阅读我！ 任何最新版本。普伦蒂斯·霍尔。
- 微软公司。 微软技术出版物风格指南任何最近的版本。微软出版社。
您可以在这些书籍组件中看到示例。 科技文档设计.
前封面和后封面
付费客户的产品文档通常都有精美设计的封面，即使书籍内部的质量很低廉。在封面上，通常可以看到以下一些或全部内容：
- 公司名称
- 产品名称
- 产品平台或操作系统
- 产品版本和发布编号
- 书名
- 公司或产品标志
- 商标符号
- 艺术作品
- 书籍订单号
- 公司或产品标语
确定公司名称、产品名称和书名的良好格式可能具有挑战性。 有时，这些可以形成整整一段文本！ 公司在是否在封面上标明版本和发布日期上意见不一—有些会；有些则不会。 然而，几乎总是可以看到平台的指示—无论产品是用于 Macintosh、PC、UNIX 等等。
封面示例。
硬皮用户指南和手册的背面通常非常简单。它通常包含书籍订购号码、公司名称及适当的商标符号、版权符号和有关书籍所有权的文字，以及说明该书在哪个国家印刷的声明。您还会在背面找到条形码。查看您的软件是否可以生成条形码—您只需访问条形码工具并输入书籍订购号码，该工具便会生成条形码。
标题页
标题页通常与封面相同，但省略了一些元素。通常省略的有插图、公司或产品徽标和口号。某些技术出版物完全省略标题页，因为这种重复似乎没有必要。（在印刷2万本的情况下，一页纸的意义重大！）
标题页示例。
版次通知
版本通知通常是技术出版物中常规文本的首次出现，尽管它通常以较小的字号显示。它位于标题页的背面。如果技术出版商采取精简环保的方法并删除标题页，版本通知将出现在封面的背面。
没有人喜欢阅读细则，但请看看通常在版面通知中包含的声明：
示例的通知公告
商标
商标的列出方式以及如何列出是公司律师的领域。无论如何，您仅列出在特定用户指南中出现的商标产品名称。
最常见的，商标通常表示为：
- 在版次通知中（如上图所示）
- 在用户指南的某个单独部分
提到那个备注。
如果公司律师希望每个商标产品名称都用星号或脚注标示，试着劝他们放弃这种页面设计的糟糕想法。在文本中随处放置星号或脚注数字会让读者分心。
保修
保修附带实物硬件产品—而不是软件。企业律师负责保修条款和格式。如果您正在为您的作品集创建示例用户指南或书籍，可以使用此匿名的“保修示例”。弹出窗 以表明您意识到必须包括保修。
软件保修？安全通知
硬件产品通常在其书籍的前面有一部分安全通知。这些通知可能作为前言的一个子部分出现，或者作为独立的部分。这些部分通常汇集了书中所有的危险、警告和注意事项，并以某种逻辑方式进行排列。但是，即使有这个前置警示，硬件书籍仍然会在适用的地方放置各个通知。（更多信息，请参见） 特别通知.)
沟通声明
硬件书籍还需要根据产品运输到的国家政府的规定提供通信声明。在美国，FCC要求根据硬件产品的“类别”提供某些通信声明。作为一名作者，您必须小心使用适合您正在记录的产品—的正确通信声明，并且不得以任何方式编辑该声明（神圣的法律用语！）。
目录
目录通常至少包含第二层级的详细信息（实际文本中的一级标题），以便读者能够更精确地找到他们所需的内容。作者、编辑和书籍设计师通常会对目录的排序进行讨论。在可用性方面，目录尽可能靠近书籍的前面会更好，甚至可以放在书的最前面。然而，从法律角度来看，人们担心所有这些沟通声明、保证、版权、商标和安全通知应当排在前面。在那些可用性获胜的地方，书籍尽可能使用各种策略将这些法律材料移出前言：保证被放在单独的卡片上，与书籍或产品一起包装；保证、沟通声明、商标等可能被放在附录中。
创建格式良好的目录有问题？请参见 创建一个专业的目录
图表清单
普通用户的技术手册通常没有图表列表。实际上，图表本身通常也没有完整的标题。但这并不是说图表列表在技术手册中没有作用。一切都取决于读者及其需求，以及书籍的内容。如果书中包含表格、插图、图表、图形等读者想直接查找的内容，则需要有图表列表。
前言
前言的功能是让读者准备好阅读这本书。它通过以下方式实现：
- 对书籍内容和目的的描述
- 识别或简要描述书籍所支持的产品
- 解释这本书适合的读者类型
- 概括书籍的主要内容
- 展示书中使用的任何特殊约定或术语
- 提供支持和市场数字，以及其他类似的内容
在传统图书出版中，前言位于目录之前；但如前所述，在 目录 技术出版人员希望将目录提前到书中的部分，以提高可用性。
正文章节
哦，是的，这些书中确实有正文—而不仅仅是前言！ 此外，我想说的是，绝大多数技术书籍都有章节或部分，有时还有部分。 请参见关于 页面设计 格式、样式和设计问题，例如标题、页脚、标题、列表、通知、表格、图形、交叉引用和突出显示。
附录
如您所知，附录是为那些在书的主要部分中似乎不适合但又不能缺少的材料而设的。附录通常是放置大型笨重表格的地方。有些技术出版物在附录中包含诸如保修之类的内容。在格式上，附录与章节是一样的，只是它被命名为“附录 A”或类似的名称，页眉和页脚也匹配这种不同的编号和命名规则（附录 A 的页码为 A-1、A-2，依此类推）。
术语表
一些技术出版物包含专门术语及其定义的部分。请注意，大多数术语表使用两栏布局。通常，每个术语及其定义组成一个单独的段落，术语使用小写字母（除非它是专有名词）并加粗，后面跟一个句号，然后是用常规罗马字体书写的定义。还要注意，定义通常不是完整的句子。好的术语定义应该使用正式的句子定义技巧，如所描述的。 定义章节 此在线文本的多重定义通常用括号中的阿拉伯数字标识。术语表段落还包含 看 首选术语的参考和 另请参见 相关术语的引用。
索引
索引通常也是两列的，并且包含 看 首选术语的参考和 另见 相关术语的引用。 请参阅本章关于 索引 有关创建良好索引的流程和指南。
读者回应表格
在互联网和社交媒体兴起之前，一些技术出版物包含了纸质表单，以便读者可以发送评论、问题和对书籍的评价。当然，事实证明这些表单更常引发关于书中所记录产品的故障的投诉。随着互联网的兴起，这些表单已经转到线上，书籍仅指向它们在线的位置。
书籍设计和排版
通常，硬件和软件制造商制作的用户指南和手册设计得相当简朴。高科技公司每隔九个月就会发布新版本和新产品。在这种情况下，复杂的设计并不实际。以下是您将看到的一些典型布局和设计特征：
- 页面大小通常由包装考虑以及印刷公司提供的标准页面大小决定。当页面大小不是限制时，一些公司会使用 8.5 × 11 英寸页面大小—这使得作家的制作过程简单得多。
- 页面通常设计为交替出现的右页和左页。左侧（偶数）页面的页脚以页码开头，并以书名结束。右侧（奇数）页面的页脚以章节标题开头，并以页码结束。
- 关于页码是整本书连续编号还是按章节编号，实践中存在不同意见。
- 除非页面相当小，否则在技术手册中，标题的悬挂式设计相对页面是很常见的。悬挂缩进通常为一英寸到一英寸半。
- 字体通常为正文使用12号Times New Roman，标题使用Arial。使用标准行距和字间距。请参见章节关于 突出显示 对于其他排版问题。
- 边距相对标准，四周为一到两英寸。通常，内侧边距会多出半英寸以便于装订。
- 通常，颜色是 不 在这些手册和指南中使用，通常考虑到成本和效率。
前言
用户指南主要章节
附录
索引
其他用户指南元素
标题
项目符号和编号列表
符号、数字和缩写
图形和图形标题
交叉引用
页码编号
用户指南的 AI 提示
清单通常未被阅读，但经过一些修改可以作为AI提示的来源。将以下内容复制，粘贴到像Google的Gemini这样的AI系统中，看看你可能遗漏了什么。
注意：有关用户指南或其组件的内容、格式、样式的所有引用均可在中找到。 在线技术写作教材.
当你想使用人工智能来评估一个写作项目时，先介绍自己，告诉人工智能你是谁，想要什么。给人工智能一个参考点，例如一本在线教科书。然后发布你希望人工智能在评估中检查的内容。
修改介绍以符合你的身份。
|
AI 提示用户指南 你好，AI。我请求你评估一位美国大学二年级学生写的说明。以下是教科书章节的摘要： 指示 和 通知 作为您评估的基础。（识别信息已屏蔽）：
|
相关信息
如何为初学者编写用户友好的帮助主题. clickhelp.com
如何编写用户文档. 科技文摘
用户指南. 技写
我很感激你对这一章节的想法、反应和批评： 你的回复—大卫·麦穆雷.
