此类不同的文档：设计vs. 面向用户

技术作家的工作致力于我最喜欢的俄罗斯技术作家-创建软件产品的文档，基本上是各种用户手册。开发文档并不容易。有许多方法和实践。例如，科学和工业企业中的技术作家经常根据GOSTs或其他国内标准进行写作。他们的目标是准确，准确地描述产品。国际公司的技术作家根据样式指南（例如Microsoft样式手册）进行撰写。在这种情况下，目标是向用户传达产品的工作原理。在这里，重点从产品转移到了读者。



我曾在不同的地方担任过技术作家，有不同的规则和政策。回顾过去，我可以说，即使在研究机构中，文本也可以针对最终用户进行重定向，文档也将从中受益。但是，在GOST中，他们不会对此进行撰写。首先，风格指南是英文的，其次，它们不在国内办事处（如NPP，KB等）中刊登广告。因此，显然缺少信息。我会尽力填补。



Yandex，Google，Microsoft和Apple产品的底座与设计工程师创建的老式文档有何不同？



经典的工程师这样写，以便按照GOST和公认的术语尽可能完整，正确地描述产品。此外，GOST中的许多术语和定义都已过时，根本不会给文档上色。但这对于构造函数来说不是问题-没有人认为文本是否易于用户理解。但是为人而建的码头是不同的：它们是用易于理解的语言编写的，并考虑了用户的利益。优先事项。



作者的这些优先事项和目标极大地影响了获得哪些文件。让我们通过示例看看它在现实生活中的外观：





碰巧您查看文档，但它们已经过时了。就像阅读1950年代拖拉机的手册一样。我们需要以某种方式使其更加相关，但这似乎是不可能的。实际上，一切皆有可能。在接下来的文章中，我将逐步分析如何从大量过时的文档集转变为实用的，易于理解的现代化码头。我们将在另一篇文章中分析表中的每个点。