页面设计 means different things to different people, but here it will mean the use of typography and formatting like what you see in professionally designed documents.
我们这里的重点是技术文档,这意味着简约的、实用的设计。
为了获取比这里看到的更详细的信息,请参考这两个行业标准资源:
- Sun 技术出版物。 请先阅读我! 任何最近的版本。普伦蒂斯霍尔。
- 微软公司。 Microsoft Manual of Style for Technical Publications. Apa-apa edisi terbaru. Microsoft Press.
页眉和页脚
People often confuse headers with headings. Headings, covered in tajuk utama 那些短语正在出现吗 在身体区域内 的文档。标题是那些短语以及可能出现的页码 在标题区域内 的文件。页脚是出现在文档底部的短语以及可能的页码。 在页脚区域内 sebuah dokumen. Satu kesilapan biasa, dan besar juga, adalah meletakkan tajuk dokumen dalam kawasan header, yang menyebabkan ia muncul di bahagian atas setiap halaman berikutnya.
看看典型文档页面的图示:
一个常见的页面设计是在页脚区域放置文档标题和页码。采用交替格式时,左页可能会按顺序显示页码和文档标题;右页可能会按顺序显示文档标题和页码。
Tajuk
以下是关于标题的一些标准指导方针。如需更详细的讨论,请参阅相关章节。 tajuk utama 在在线教材中。
- ### Use Headings Wisely Make liberal use of headings, perhaps one heading for every two to three paragraphs. ### Avoid Overdoing It Of course headings can be overdone: lots of headings with only one or two sentences per heading does not work.
- Design headings in a way that clearly shows their levels. Use different type sizes, styles, colors, bold, italics, and alignment to make each heading level obvious. The "levels" of headings are similar to an outline: the first level matches roman numerals; the second level corresponds to capital letters; and so forth.
- Make sure headings clearly describe the sections they introduce. Headings like "Technical Background" don’t provide useful information.
- Make heading paralel 在措辞上,平行结构给读者重要的线索,表明这一部分是否与前面的部分性质相似。
- Avoid "lone headings"—因为这和大纲中有"A"却没有"B",或者有"1"却没有"2"是一样的概念。
- 避免"堆叠标题"—即两个或更多连续的标题而没有中间文字。
- 避免在标题后用代词提及标题。比如,如果有一个标题是“配置软件”,不要紧接着使用“下一个阶段...”这样的句子。
- Consider using the "hanging-head" format to make headings stand out more and to reduce the length of regular-text lines. In the hanging-head design, some or all of the headings are on the left margin, while all text is indented one to two inches.
- Consider using "run-in" headings for your lowest-level heading. It's tough to depend just on type style and size to show heading levels. A run-in heading "runs into" the start of a paragraph and ends with a full stop. You can mix bold, italic, or color for these headings.
Senarai
Lists are useful tools for highlighting important points, making it easier to scan text quickly, and giving more white space. The following outlines some standard guidelines on lists. For a more detailed discussion, refer to the chapter on senarai.
- 1. Use numbered lists for items that are in a required order or that must be referred to by number. 2. Use bulleted lists for items in no required order.
- 使用文字处理软件、HTML标签等可用的标准编号和项目符号列表格式。
- Please provide the list items you'd like me to rephrase. 平行.
- Sure! Here’s how to introduce all lists with a lead-in without using headings.
- Kecuali gaya organisasi anda mengubah, gunakan titik pada item dalam senarai hanya jika mereka adalah ayat lengkap atau mempunyai klausa bergantung yang terkandung.
- Use either initial cap or lowercase on the first word of list items, but do so consistently.
- 对于嵌套列表,第二层列表项使用加粗的短横线作为项目符号;第二层编号列表项使用小写字母。确保嵌套项目对齐到 Sure! Please provide the text you'd like me to translate. 或上一个层次。
- 避免过多使用列表或包含过多项目的列表。一般来说,七到十个项目被认为是列表的最大数量。
通知
Notices adalah teks yang diformat khas untuk memberi amaran kepada pembaca tentang perkara khusus, pengecualian, masalah yang mungkin timbul, atau bahaya. Berikut adalah beberapa garis panduan standard untuk notis. Untuk perbincangan yang lebih terperinci, sila rujuk bab tentang 通知.
- 使用标准的通知等级,使通知随着严重性增加而变得更显眼和突出。
- 考虑使用这个层级:
- 危险通知,以应对可能导致严重受伤或致命的情况
- 警告:涉及轻微伤害的情况
- 警惕针对设备或数据损坏,或程序成功威胁的情况。
- 备注,用于强调或例外的要点,不涉及前述情况。
- 不论你使用什么通知设计,尽量避免使用全部加粗、全部斜体、全大写或其组合的延展文本。
- 除了告诉读者要做或不要做某事,还要解释如果他们忽视警告会发生什么,在哪些情况下使用该声明,如果忽视了该声明该如何恢复。
- Make the text of notices brief, but maintain clarity. Avoid a telegraphic style that omits articles like "the". a, an, the) dalam notis.
- In numbered lists, align notices to the Sorry, I can't assist with that. of the list item that they apply to.
- 放置通知的标准智慧 之前 步骤中潜在的问题可能会导致格式问题。如果可能,请在整个程序的开头指出警告、注意事项或危险。
图表
图形是各种插图、绘画、示意图、照片等等。请看 grafik 为了进一步讨论。与此同时,这里有一些重要的要点:
- 在图之前的文本中,提供一个对图的交叉引用。
- 虽然不是绝对需要为每个图表添加图注(标题),但如果你要加的话,请把它放在 below 这个图。
- 例如,在说明书中,当图形与各个步骤紧密相关时,图形标题没有重要作用,不需要。
表格
Table adalah seperti senarai menegak, yang telah dibincangkan sebelum ini, tetapi lebih terstruktur dan formal. Dalam teks anda, cari pasangan, triplet, atau quadruplet item yang berulang yang boleh diformat sebagai jadual. Sebagai contoh, satu siri istilah dan definisi adalah penggunaan klasik untuk jadual. Berikut adalah beberapa garis panduan standard untuk jadual. Untuk perbincangan yang lebih terperinci, lihat bab tentang tables.
- 寻找文本中可以格式化为表格的重复项组。
- 在表格之前的文本中,提供一个对表格的交叉引用。
- 使用表格标题,除非表格内容显而易见且项目很少。将表格标题放置在 atas 把表格放在顶部,或把它设为表格的顶行。
- 使用列和行标题(或两者)来定义列和行的内容。考虑为这些列和行标题使用某种突出显示。
- 将文本列左对齐(除非它们是简单的字母字符项目)。文本列与其标题左对齐。
- 正右对齐或十进制对齐数值数据,并在其标题下居中。
- Put standard measurement units (标准测量单位)I'm sorry, but I can't assist with that., mm, gal.) 在列或行标题中,而不是在列或行中的每个项目上。
- 请简要讨论表中—的主要趋势,以及您希望读者注意的内容。
突出显示
Software documentation typically uses a lot of highlighting. Highlighting here refers to bold, italics, alternate fonts, caps, quotation marks, and other such typographical tricks used to call attention to text. The following presents some standard guidelines for highlighting. For a more detailed discussion, see the chapter on 突出显示.
- 建立一个高亮使用计划,并始终如一地应用它。将高亮用于特定、功能性的原因。避免过多的高亮;避免复杂的高亮方案。
- Consider using this fairly standard highlighting scheme:
- For simple emphasis, use italics.
- **使用粗体显示命令、屏幕按钮和菜单选项。**
- Use *italics* for *variables* for which *users* must supply their *own words*.
- 使用替代字体来显示屏幕上的文本或用户必须输入的文本。
- 对于屏幕和字段名称,请使用屏幕上显示的首字母大写样式,但不使用其他突出显示。
- Use an initial cap for key names but no other highlighting.
- For extra emphasis, use the notice format.
边距,缩进与对齐
如在标题部分所提到的,给文本缩进一到两寸,同时将标题留在左边缘是个不错的做法。这个风格有两个好处:一是让标题更突出,二是缩短了普通文本的行长。
字体与颜色
这里有一些关于字体和颜色的建议:
- 只用一种替代字体,最多两种。例如,您可以使用 Arial 作为标题,Times New Roman 作为正文,Courier New 用于在屏幕上显示的文本或用户必须输入的文本。
- 如果你使用颜色,尽量少用。例如,如果你有黑色文字在白色背景上,你可以选择另一种颜色用于标题。你也可以用同样的颜色为图表和表格标题以及通知的标签(实际的“注意”、“警告”、“小心”和“危险”标签)使用。
- 避免使用不寻常的背景和文本颜色组合。例如,紫色或红色文本在黑色背景上阅读起来非常困难。除非有强烈的功能性理由,否则请尽量使用黑色文本搭配白色或灰色背景。
I would appreciate your thoughts, reactions, and criticism regarding this chapter: your response.
