现在是一个穿靴子的鞋匠，或者我们如何获得自己的风格指南

我想，亲爱的读者，在您的工作中，您必须处理技术文档，甚至可能要与创建技术文档的人员（技术作家）打交道。在我们的博客上，您可以遇到Veeam团队的技术作家。

今天，我们将进一步了解Veeam Software中技术文档的开发方式。

KDPV在欺骗-这不是奇迹，而是与所有其他研发同事一样的工作。但是，那些创建指南的人对于创建指南的指南有神奇的词汇！这是这样的递归。

在我的同事Daria Shalygin的故事中阅读更多内容。

嗨，我叫Dasha，我是Veeam Software的内容质量负责人。我对我公司技术作家部门创作的内容的质量负责。实际上，我是一位技术作家和编辑。我的职责包括：

• 运行我自己的项目-像所有技术作家一样，我有我的职责范围，即我要为其创建和维护文档的许多产品;
• 培训初级员工-我为“初学者”创建了入门课程，我用它来解释编写文档的基本规则；
• 向更高级别的员工（经验丰富和高级）提供建议-我计划安排每天的会议，在此期间我们的团队中的任何成员都可以问我有关文档的任何问题（无论是措辞，结构等）；
• — , , , .

仅3年前，我们只有8名技术作家。当新来的人来时，他研究了现有的指南，并开始以大致相同的方式写作。那是我们所有人都拥有相同美感的美好时光，我们可以毫不费力地就如何编写产品文档达成共识。

时间流逝，公司不断壮大，产品越来越多，并且有必要增加技术写作人员。今天，我们已经有18个人了，我们不打算在那里停下来。一切都会好起来的，但突然之间，事实证明，要让如此多的人达成共识，就很难了。这需要时间，一次又一次。

为了减少将知识转移到新产品上以及一劳永逸地修复Veeam技术文档中“美丽”的能源成本，决定创建我们自己的样式指南。我必须说，关于样式主题的一些草图已经以关于融合性和笔记本中的边注的文章的形式存在了很多年，但是所有这些都是无序的，零散的，并且当然是在谈论信息的任何易用性和相关性不必。

它是：



当我们创建样式指南时，我们以3个大型指南为基础，通常在编写文档时将它们作为示例：（《芝加哥样式手册》，《微软样式手册和DITA最佳实践》），研究了其他公司存在的许多第三方样式指南（例如，IBM样式指南，OpenSolaris的文档样式指南等），对文档领域的最新趋势进行了研究-并将所有这些与我们在Veeam软件领域的11年经验相结合。 结果

变成了：



因此，《Veeam技术写作风格指南》包括了以下主题主题：按主题类型来结构化内容，简单的英语原则，标点符号，文章，格式，绘制屏幕截图和图表，绘制指向您自己和第三方文档的链接以及对以下内容的有用提示每天。

随着样式指南的问世，我们不仅促进了向新员工传授知识的过程，而且获得了以下优势：

• 避免需要在第三方风格的爬行动物和互联网上搜索定期出现的问题的答案；
• 立即解决有关文件的语言，设计和结构的有争议的问题；
• 方便地浏览自己的知识库；
• 能够向其他部门的同事提供指向特定部分的链接，这些部门直接或间接地工作于编写文本（无论是支持还是QA）。

一个著名的模因，关于您在担任技术作家之后的写作风格会发生怎样的巨大变化，

我们的风格指南是由非母语人士（非母语人士）创建的，旨在供非母语人士使用。尽管如此，它还是由我们的母语，行销语言学家阅读和验证的，这些语言者受过适当的教育，为公司的网站撰写了较长的文字，并根据上述巨头的原则制定了自己的风格指南行业。

我们目前正在努力扩展我们的知识库。我们想为参考文档（例如REST API参考和PowerShell参考）创建单独的样式指南。对于此类文档，需要以特殊的方式来构造内容，并且需要对其进行固定以保持产品之间的一致性。

如果我们的风格指南对仍在寻找自己风格的其他公司有用，我们将感到高兴。我建议您阅读本节中的背景信息，根据我们的经验，在工作中经常需要这些信息 -有很多有趣的事情。:)

Veeam技术写作风格指南（英语）