在我的文章“技术写作工作的弊端”中，我提到技术作家应遵循风格准则和标准，因为技术文档应简洁明了且语法正确。 但是新手可能会问，他们应该遵循哪些样式指南？ 为了回答这个问题，我创建了一个列表，您将在下面找到它。
首先，让我们弄清楚什么是样式指南。 样式指南是一套用于编写和设计内容的标准； 它定义了在特定组织内进行沟通时应使用的样式。 例如，如果您具有新闻学背景，则可能已阅读《芝加哥风格手册》。 该样式指南提供了有关语法和语法的常规信息。 但这仅不足以编写技术文档。
为了以更清晰的方式编写文档并在文档中保持一致的语调，声音和样式，请阅读并遵循以下样式指南之一：
- 列表式样式指南
List Apart探索了Web内容的设计，开发和含义，特别关注Web标准和最佳实践。
- Techprose技术写作指南
自1982年以来，TechProse就是一家业务领域的技术写作，培训和信息技术咨询公司。该手册提供了技术写作指南，并为创建逻辑性和专业性的书面材料设定了标准。 TechProse将其提供给与TechProse员工一起学习技术写作的工作人员作家，顾问和学生。
- 微软风格手册
最大限度地提高信息的影响力和准确性！ 现在，在其第四版中，《 Microsoft样式手册》为内容创建者，新闻工作者，技术作家，编辑以及其他撰写计算机技术的所有人提供了基本指南。 直接来自Microsoft的编辑样式委员会-您可以获得有关通用技术术语和Microsoft专有术语的全面词汇表； 清晰，简洁的用法和样式指南以及有用的示例和替代方法； 语法，语气和语音指导； 以及为网络编写内容，针对可访问性进行优化以及与全球受众进行交流的最佳做法。 Microsoft样式手册经过全面更新和优化，易于使用，旨在帮助您在广泛的受众和媒体中就技术主题进行清晰，一致和准确的交流。
- 牛津风格手册
《牛津大学风格指南》旨在为员工代表大学（或其组成部门之一等）撰写的文件和格式设置文档提供指南。 它是大学品牌工具包的一部分，该工具包使大学的正式文档可以在所有通讯中一致地显示。
- IBM样式指南
每个主题都针对最常见的情况，并在适当的地方提供示例。 除某些例外，developerWorks样式基于IBM样式，该样式在《 IBM样式指南：作者和编辑者的约定》中定义。 侧栏指示《 IBM样式指南》中的相关部分。 有关该developerWorks指南中未记录的更多示例和案例，请参阅IBM指南。 自developerWorks网站成立以来，此处概述的大多数约定和样式指南都是标准实践。 但是，就像任何有效的编辑风格一样，developerWorks风格也不断发展，以适应读者消费内容方式的变化。 在应用标准和准则时，请考虑以下想法，以使文章样式现代化。
- 技术写作手册
从正式的报告和手册到日常电子邮件，《技术写作手册》使用智能，易用的语言来聚焦和阐明当今的技术写作。 数百个主题条目，90多个示例文档，一览表和动态视频破坏了成功作家用来清晰而有说服力地传达技术信息和数据的最佳实践，模型和实际技能。
该书由传奇的作家团队开发，具有数十年的学术和专业经验相结合，该书直观，按字母顺序排列，可轻松浏览其语法，用法和样式的广泛内容。 此外，对紧迫问题的最新，更深入的处理，例如求职，写作过程，文档来源和社交媒体，在课堂上和工作上都引起了共鸣。
- A11Y样式指南
A11Y样式指南随附了预填充的可访问组件，其中包括指向相关工具，文章和WCAG准则的有用链接，以使您的网站更具包容性。 这些组件还可以作为HTML标记和SCSS / CSS代码的指南，以在网站创建的各个阶段通知设计人员，前端和后端开发人员。
- 打开SUSE样式指南
本指南提供了在编辑SUSE文档时常见的书写，样式和布局问题的答案。 本指南末尾的GeekoDoc / DocBook标记参考将帮助您选择合适的XML元素。 遵循本指南将使您的文档更易于理解和翻译。
结论
一些作者发现以下样式指南具有限制性，因为例如，他们更喜欢语法结构上的自由。 但是您绝对应该阅读并遵循它们，因为样式指南使您的文档更加有效且易于理解。
