请点击这里以获得帮助 David McMurrey 付网络托管费：
捐赠任何你能的少量金额
在线技术写作将继续免费。
这个页面正在维修中。
A 用户指南 是一本技术文档，解释用户如何执行产品的常见任务。常见 tugas 是用户需要能够执行的操作。 用户 is at a level of knowledge and experience intended by the product. Some products have basic users and advanced users—a user guide can fulfill one of those needs or both. Think of a microwave oven: it can have a basic user, and that's about it. On the other hand, a graphic design product can have both basic users and advanced users.
NotebookLLM 生成的这一章节的信息图表
Dalam bab ini, 书籍设计 意味着书籍的各种典型组成部分的内容、风格、格式、设计和顺序。这里的“组成部分”指的是书籍的实际部分或页码，如版次通知、前言、索引或封面或封底。在 halaman-reka bentuk bab, the term elemen 是指可以在书中任何地方多次出现的事物，比如标题、页脚、表格、插图、列表、通知、高亮等等。
以下将概述一本印刷技术书籍的典型组成部分，以及这些组成部分的典型内容、格式、风格和顺序。确实，没有任何单一的用户指南、技术参考手册、快速参考文档或其他此类文档会以您将要阅读的精确方式设计和排列所有这些组件。相反，这个回顾将提供一种可能性的概述——我们可以说是可能性的范围。
Nota: 目前，我们只有一个例子 pengguna panduan developed in FrameMaker then output to PDF. It lacks a glossary, but all other parts of a typical user guide are in place. (I can't figure out that "d" in "Filepad"!) Please note that it does not comply with some of the font and margin requirements listed below.
Before you start reading the following, grab some hardware and software books so you can compare their content, style, format, and sequencing with what is discussed here.
Untuk maklumat yang lebih terperinci daripada apa yang anda lihat di sini, rujuk kepada dua sumber industri standard ini:
- Sun Technical Pubs. 先看我！ 任何最近的版本。普伦蒂斯霍尔。
- Microsoft Corporation. Microsoft 手册技术出版物风格指南. 最近的版本。微软出版社。
你可以在这里看到这些书籍组件的例子 Techdoc 设计.
前后封面
付费客户的产品文档通常有精美设计的封面，即使内页的质量偏低。封面上通常会看到以下一些或全部内容：
- Syarikat nama
- 产品名称
- 产品平台或操作系统
- 产品版本与发布编号
- 书名
- 公司或产品标志
- 商标符号
- 艺术品
- 书籍订单号
- 公司或产品口号
It can be challenging to figure out a good format for the company name, product name, and book title. Sometimes, these can amount to a whole paragraph of text! Companies are quite divided on whether to indicate version and release numbers on front covers—some do; some don't. Almost always, however, you'll see the platform indicated—whether the product is for the Macintosh, the PC, UNIX, and so on.
封面示例。
硬拷贝用户指南和手册的背面通常非常简单。一般来说，它包含书籍订购号码、公司的名称及适当的商标符号、版权符号和关于书籍所有权的措辞，以及关于书籍印刷国家的声明。你还会在背面找到条形码。看看你的软件能否生成条形码—你只需访问条形码工具，输入书籍订购号码，工具就会生成条形码。
封面页
The title page is usually a copy of the front cover, but without some elements. Usually left out are the artwork, company or product logos, and slogans. Some technical publications skip the title page altogether as it seems like unnecessary duplication. (And for a print run of 20,000 copies, one page makes a big difference!)
示例标题页。
版次通知
版次通知通常是技术出版物中常规文本的首次出现，虽然它通常使用较小的字体。它出现在标题页的背面。如果技术出版商采取节俭与环保的方式并省略标题页，则版次通知将出现在封面的背面。
没人喜欢看小字，但看看通常在出版通知中包含的声明：
示例的通知
商标
Whether you list trademarks and how you listen is the area of company lawyers. In any case, you only list those trademarked product names that appear in that specific user guide.
最常见的，商标通常用以下方式表示：
- 在版次通知中（如上面的插图所示）
- 在用户指南的某个单独部分
提一下那个笔记
如果企业律师希望每次出现商标产品名称时都用星号或脚注注明，试着劝说他们放弃这种糟糕的页面设计。在文本中到处加星号或脚注数字会让读者分心。
保修
Warranties only come with physical hardware products—not software. Corporate lawyers handle all the warranty wording and structure. If you're putting together a user guide or book for your portfolio, you can use this anonymous "warranty example".弹出窗口 以显示您意识到保修必须包含在内。
软件保修？安全通知
Hardware products usually have a safety notice section at the start of their manuals. This might be a subsection of the preface or a standalone section. These sections usually compile all the danger, warning, and caution notices found throughout the manual and organize them logically. However, even with this initial alert, hardware manuals still include individual notices at the relevant points. (For more information, see 特别通知.)
沟通声明
Hardware books juga memerlukan kenyataan komunikasi seperti yang ditetapkan oleh kerajaan negara-negara ke mana produk ini dihantar. Di AS, FCC memerlukan kenyataan komunikasi tertentu bergantung pada "kelas" produk perkakasan. Sebagai seorang penulis, anda perlu berhati-hati untuk menggunakan kenyataan komunikasi yang betul untuk produk yang anda dokumen—dan tidak mengubah kenyataan tersebut dengan cara apa pun (kata-kata undang-undang yang suci!).
目录
目录（TOC）通常至少包含第二级的细节（实际文本中的标题1），以便读者能更准确地找到他们需要的内容。作者、编辑和书籍设计师通常会争论TOC的排序。在可用性方面，将TOC尽可能靠近书籍的前面是更好的选择，最好是在书的最前面。然而，在法律方面，人们担心所有这些沟通声明、保证、版权、商标和安全通知应该放在前面。在可用性占优的情况下，书籍会采取各种策略将这些法律材料移出前言：保证书会放在单独的卡片上，并与书籍或产品一起缩小包装；保证书、沟通声明、商标等可能被放入附录中。
创建格式良好的目录有问题吗？请查看 创建一个专业的目录
图表列表
Technical manuals for regular users usually don't include lists of figures. In fact, the figures often don't have complete figure titles. However, this doesn't mean a list of figures is irrelevant in technical manuals. It really depends on the reader and their needs, as well as the content of the book. If the book has tables, illustrations, charts, graphs, and similar items that readers will want to locate easily, a figure list is a good idea.
前言
前言的功能是让读者准备好阅读这本书。它通过以下方式做到这一点：
- 描绘这本书的内容和目的
- 识别或甚至简要描述该书支持的产品
- 解释这本书适合哪种读者
- 概述这本书的主要内容
- 显示书中使用的任何特殊惯例或术语
- 提供支援和市场数据，还有其他类似的
在传统书籍出版中，前言位于目录之前；但如前面所讨论的， 目录 section, technical publishing people want the TOC to appear earlier in the book for usability reasons.
Badan bab
哦，是的，这些书里面确实有实际的文字—不是全是前言！这里没什么好说的，只是大部分技术书都有章节或部分，有些情况下还有部分。看看这一章关于 页面设计 untuk format, gaya, dan isu rekaan bagi elemen seperti tajuk, footer, heading, senarai, notis, jadual, grafik, rujukan silang, dan penonjolan.
附录
如你所知，附录是为了那些似乎不适合书本主部分但也不能遗漏的材料。附录通常是存放大型复杂表格的地方。一些技术出版物会在附录中包含保修等内容。在格式方面，附录就像一个章节，区别在于它被命名为“附录 A”或类似的名称，而页眉和页脚也会对应不同的编号和命名规范（附录 A 页面的编号为 A-1，A-2，依此类推）。
Glosari
一些技术出版物包括一个专业术语和定义的部分。请注意，大多数词汇表使用两列布局。通常，每个术语及其定义形成一个单独的段落，术语小写（除非它是专有名词）并加粗，后面跟一个句号，然后是用常规罗马字母写的定义。还要注意，定义通常不是完整的句子。好的词汇表定义应该使用正式句子定义技术，如所述 definisi bab of this online text. Multiple definitions are typically identified by Arabic numbers in parentheses. Glossary paragraphs also contain 看 参考首选术语和 请参阅 相关术语的引用。
索引
索引通常也是双列的，并且还包含 看 偏好的术语参考和 看也可以 与相关术语的引用。 请参阅章节关于 索引 为创建良好索引的流程和指南。
读者反应表格
在互联网和社交媒体兴起之前，一些技术出版物包含了纸质表格，让读者可以提交评论、问题和书籍的评价。当然，结果是这些表格更常引发对书中记录的产品故障的投诉。随着互联网的兴起，这些表格已经转到网上，书籍只是指向其在线位置。
书籍设计与排版
通常情况下，硬件和软件制造商制作的用户指南和手册设计得相当简约。高科技公司每隔九个月就会发布新版本和产品。在这种情况下，复杂的设计实在不切实际。以下是一些你会看到的典型布局和设计特点：
- Page size often depends on packaging needs and standard sizes from printing companies. When page size isn't an issue, some companies will use the 8.5 × 11-inch page size— which makes it much easier for writers to produce.
- Pages are usually designed with alternating right and left pages. The footer for the left (even) page starts with the page number and ends with the book title. The footer for the right (odd) page starts with the chapter title and ends with the page number.
- 实践上，对页码是整本书连续还是按章节编号的看法不一。
- Kecuali halaman kecil, reka bentuk kepala tergantung bagi tajuk berkaitan halaman adalah biasa dalam manual teknikal. Indent tergantung biasanya satu inci hingga satu setengah inci.
- 字体通常为正文使用12号的Times New Roman，标题则使用Arial。使用标准行间距和字间距。请参阅章节关于 高亮显示 关于其他排版问题。
- 边距通常是标准的，四周在一到两英寸之间。一般在内侧边距多加半英寸，以便于装订。
- 通常，颜色是 not 用于这些手册和指导中，通常是出于成本和效率的考虑。
目录
TOC
无论你使用哪种目录格式，这些都是常见的标准：
- Laman mula sahaja. 虽然一些自动目录生成器显示页面范围，但标准只显示第一页号码。
- 需要包括的标题级别。 如上面的目录所示，展示前两个级别的标题，除非用户指南有很多子标题。目录应以一目了然的方式快速寻找信息。
- Spacing dan kapitalisasi. 注意上面目录中的文本项是如何缩进的。第一层标题使用全大写；第二层标题在每个主要词上使用首字母大写；第三层标题使用句子样式的大写。
- 垂直间距。 注意到一级章节上方和下方有额外的空白，这样可以提高可读性。
根据您组织的要求，您有两种格式选择来制作目录 (TOC)：
This TOC uses decimal-numbering style for the chapter and section numbers, which is common in user guides. Others in this book use uppercase roman-numeral style for the top-level chapters only (see ).
有难度制作格式良好的目录吗？请查看 Create a professional-looking TOC
逗号和页码。 如果不需要领导者点格式，并且您希望避免使用它，您可以使用这种普遍接受的格式：
Dapat lihat contoh pra-kata ini:
简单的目录文本，带有逗号和页码。图表列表
不常包含在用户指南中...
-->前言
Pengguna Panduan Bab Utama
附录
索引
其他用户指南元素
Tajuk-tajuk
- Dotted dan Nombor Senarai
符号、数字和缩写
图形和图例标题
交叉引用
页面编号
AI 提示用于用户指南
Checklist, usually ignored, can be a source for AI prompts with some tweaks. Copy this, paste into an AI system like Google's Gemini, and check what you might have overlooked.
Nota: Semua rujukan kepada kandungan, format, gaya panduan pengguna atau komponen mereka boleh ditemui di dalam 在线技术写作教科书.
当你想用AI来评估一个写作项目时，先介绍自己，告诉AI你是谁，你想要什么。给AI一个参考点，比如在线教科书。然后发布你希望AI在评估中检查的内容。
Modify the introduction to reflect your identity.
|
AI 提示用户指南 Hello, AI. I am requesting that you evaluate instructions written by a U.S. college sophomore. Below is a summary of textbook chapters on 指示 and 通知 用作你评估的基础。（识别信息已被隐藏）：
|
相关信息
如何为初学者编写用户友好的帮助主题. clickhelp.com
如何撰写用户文档. 技术写手
用户指南. techscribe
I would appreciate your thoughts, reactions, and criticism regarding this chapter: your response—David McMurrey.
