没有风格指南，就很难创造出伟大的技术内容。无论您的文档有多么不同，风格指南都将帮助您的技术作者团队确保所有文档的一致性。你可以为不同的目标受众写作，但是你所有的文档都必须基于一种风格指南。它将是你大部分技术内容的基本指导文件。这篇博客将解释风格指南如何对你的公司和客户有用。 什么是技术写作风格指南？ 你可能已经注意到，拥有与众不同的风格就像拥有一副特别的嗓音。这就好像你开发了一种新的语言——一种你用来与目标受众交流的语言。这种语言包括措辞和所有文档的一般模式和布局。 特定的风格有助于读者将你的内容与一个来源联系起来。这让你的产品更容易被顾客认出来。为了达到这种效果，你需要一个技术写作风格指南，一个帮助你建立和扩展你的公司知识库并使你的内容一致的基本文档。 样式指南是一种参考文档，包含编写和设计文档的规则集合。 该文档的目的是作为创建新文档、重写和更新现有文档的大纲和要求列表。这是一个“框架”，旨在确保你的技术写作团队制作的所有东西在风格上都是一致的。 本参考指南中列出的要求涉及以下主要领域： 句法（关于标点符号、大写、缩写和缩写等的建议。）； 格式（表示数字、日期、表格等的规则。）； 设计（披露公司理念的一大块信息，涉及调色板、插图、截图、照片、图表等。）。 这些建议将帮助你的技术写作团队创作出统一的、吸引读者眼球的内容。如果你的公司风格指南包括样本、模板或例子，可以帮助技术作者更快地工作，避免最常见的错误，那就太好了。 为什么技术写作风格指南很重要？ 如果你是一名执业技术作家，你可能会订阅许多在线论坛或博客，在那里你会关注一两个讨论在美式或英式英语中使用单双l或在官方文件中使用非人称代词如they的帖子。你很清楚，这样的问题在你的实践中经常出现，每次出现这样的问题，你都必须解决。 几天前，我目睹了两位来自不同文化的作家之间真正的“战斗”。他们讨论了用哪种符号来分隔小数：点还是逗号。事实是，在一些国家，正确的符号是点，而在另一些国家，它是逗号。 有了风格指南，这些问题就不会出现了。它们会在公司参考书里一劳永逸地解决，你和你的同事只需要按照既定的顺序去做。 因此，技术写作将变得更加高效，您的文档将开始看起来统一。你可能需要一些培训，因为不是所有的写作人员都会在开始时查阅风格指南。但是很快，他们就会养成这个习惯。你只需要证明，如果他们从一开始就遵循共同的规则和标准，这将为他们节省大量的时间和精力。他们将不再需要每次遇到每一个模棱两可的时刻都进行讨论。所有棘手的问题都将在指南中解决。 现在让我们从另一个角度来看看写作过程。他们说分享一个问题是问题减半。然而，在一个文档上工作的作者数量越多，内容在风格上就变得越脆弱。具有讽刺意味的是，参与工作的人越多，不一致的地方就越大。 在这种情况下，使用指南是一个真正的补救措施。如果您有几个受让人处理同一个文档，这将特别有效。它们都将参考相同的一套规则和要求，在大型团队中工作的整个复杂过程将变得不那么混乱。 风格手册的另一个优势是，它在入职过程中是不可或缺的。它可以作为新员工的培训工具。起初，他们将不得不经常参考它，但很快，他们将能够闭着眼睛格式化和设计文档。 撰写技术写作风格指南的步骤 以下信息不仅限于列出的步骤。它们可以被视为一种推荐，你的企业技术写作风格指南中的信息可以更全面。 第一步是最一般的一步。在这个阶段，你必须将所有与风格相关的信息分成两大块：视觉内容和书面内容。 视觉块指的是贵公司的品牌政策。它描述了公司的调色板、徽标、字体、背景等。，这应该应用于所有发布的内容。 书面部分是文本本身及其格式规则（页面设置、标题、列表、引用等）。）。书面部分还包括出版物的总体基调，如中性、公事公办或随意。 在下一步中，这两个块（关于视觉和书面信息）应该用您想要包含在样式指南中的要求来填充。换句话说，第二步是制定需求。 大多数人认为制定书面部分的要求是最具挑战性的事情。事实上，这是创建风格指南最透明、最清晰的部分。事实是，这些信息已经在许多国际知名的文体指南中有所描述，如美国心理学协会（APA）的出版手册、现代语言协会的MLA文体手册和芝加哥文体手册（CMOS）。 这些是学术写作中最常用的风格指南，技术语言与之非常接近。所以，不要犹豫，在你的公司风格指南中使用这些指南中的信息。这些最先进的文体指南包含关于以下问题的现成信息： 纸张格式（字体、标题、行距、页边距、页面顺序、页眉、段落、对齐和缩进、标题页设置）； 正文引用（转述、引用等。）； 风格机制（缩写、大写、斜体和引号、列表、数字、标点符号、拼写和断字）； 无偏见的语言（年龄、性别、种族和民族身份等。）； 表格和图表（图表设置、样本图表、样本表格、表格设置）； 语法（主动语态和被动语态，单数“他们”，动词时态，以及其他问题）。 上面的列表对你的风格指南中涉及文本的部分非常有帮助。至于视觉部分，它更多的是针对公司的，必须单独开发。 第三步，你必须让你的写作团队熟悉风格指南。您可以使用不同的方法来完成，但最明显的方法是将其分配给公司知识经理，他将举办一系列关于使用指南的培训。知识经理还必须确保每个人都能访问该指南。 单击帮助和技术写作风格指南 在你的实践中，你必须写不同的文档来吸引不同的目标受众（包括你产品的潜在客户和内部受众）。这些可能是用户手册、快速入门指南、白皮书、员工手册、PRD（产品需求文档）等。 其中一些文档可能看起来非常相似。例如，对于一种产品的不同版本，您可能有非常相似的PRD。实际上，他们几乎是相同的医生，但口音不同。 ClickHelp是一个基于单一来源和内容重用原则的在线文档管理平台。这意味着您可以拥有一个基本文档（如上例所示的源PRD）并发布它的不同版本。 此外，ClickHelp还提供了一些片段和变量，可以帮助您更改文档，使某些元素在一个出版物中可见，而在另一个出版物中不可见。这将帮助您在不同版本的文档中使用不同的重音符号。 让我们举一个不同的例子。例如，有一家公司生产齿轮箱和压缩机。你有一个包含齿轮箱和压缩机所有信息的标准目录。然而，你的目标受众中有一部分只对压缩机感兴趣。在ClickHelp中，您可以编辑源文档，以便只有与压缩器相关的内容在出版物中可见。 ClickHelp对于发布不同格式（HTML、PDF、doc、docx等）的文档特别方便。）。因此，您的客户将能够从智能手机、平板电脑甚至电子书上打开您的文件。 ClickHelp对于设计内容的视觉外观非常有用。ClickHelp中提供了现成的模板，这将使文档品牌化更加容易。如果使用模板对你来说还不够，你想实现一个更深刻的品牌方法，你可以打开和编辑CSS文件，这些文件与你在系统中创建的每个项目一起出现。 结论 如果你的公司没有风格指南，现在是时候考虑在你的内容创作过程中引入一个了。样式指南将有助于使您的文档更可预测，从而更具可读性。这种效果是通过为你的公司作者和审稿人制定共同的惯例来实现的。如果你设法在你的公司引入一本风格手册，你将能够简化和控制你的写作过程。 祝你的技术写作好运！ 单击帮助团队 跨平台和设备创作、托管和交付文档