技术文件类型小小书 XXshu

by ClickHelp —最佳帮助创作工具

您是否曾经为工作创建简历，准备演示文稿或给老板写过电子邮件？然后，您已经编写了技术文档。

技术写作包括各种文档。它们包括说明，评论，报告，新闻通讯，演示文稿，网页，小册子，提案，信件，传单，图形，备忘录，新闻稿，手册，规范，样式指南，议程等。它们太多了，为了理解它们之间的差异，我们需要将它们分为几类。在本文中，我们将尝试这样做。

技术文档的主要要求之一是其针对目标受众的方向。根据目标受众，技术文档分为两种主要类型：

工艺文件 。这些描述了系统的开发，测试，维护和改进。流程文档由经理，工程师，测试人员和市场营销专家使用。这些文档包含技术术语和行业专用术语。此类文档的示例包括API，SDK和代码文档；内部开发文档等

用户文件 。此类文档为客户提供了使用产品所需的信息。用户文档主要包含指导和说明材料。这些文档使用日常用语代替技术术语 ，因此即使对于新手读者而言，它们也清晰，简洁且有帮助。分步演练，用户指南，故障排除文档可以作为示例。

技术文档种类繁多，无法一一列举。但是，我们试图将它们分为几类。

我们提出了以下方案：

你怎么看呢？我们错过了什么吗？

技术文件的分类和清单的数量是无限的。虽然创建演示文稿或一般报告不需要特定知识，但是某些技术文档相当复杂。下面，我们列出了一些最先进和广泛使用的示例，供您了解一些示例：

用户指南（手册）是一份技术交流文档（以及该列表的其余部分），旨在为特定系统的用户提供帮助。主要关注可以通过GUI完成的任务。使用的语言要与目标受众相匹配，术语要尽量少用或完全讲解。
发行说明是随软件产品一起分发的技术文档，其中包含错误修正和附加功能。它们通常与组织的最终用户，客户和客户共享。
API（应用程序编程接口）文档描述了API提供的服务以及如何使用这些服务，旨在涵盖客户出于实际目的需要了解的所有内容。传统上，它可以在文档文件中找到，但也可以在社交媒体中找到，例如博客，论坛和问答网站。

SDK（软件开发工具包）文档是一套完整的API，可让您执行创建应用程序所需的几乎所有操作，以及用于为其开发平台的其他工具。所有SDK都是（包含）API，但并非所有API都是SDK。
市场需求文档（MRD）是一种技术文档，表达了客户对产品或服务的需求。它通常会说明目标受众是谁，与该产品竞争的产品是什么，为什么客户可能想要该产品。
用户需求文档（URD）（用户需求规范）是一种技术文档，它指定用户希望软件能够执行的操作。 URD中记录的信息旨在准确说明软件必须执行的操作，并成为合同协议的一部分。客户不能要求URD中没有的功能，而开发人员如果错过了URD项，则开发人员无法声称产品已准备就绪。

其他高级技术文档示例包括：体系结构和工程文档（A＆E Docs），帮助文件，标准操作程序（SOP）手册，安装指南，故障排除指南，系统配置指南，代码文档，操作方法，参考表，白皮书，常见问题解答，问答，参考表等

您是否曾经处理过任何技术文档？您会挑选哪些类别的技术文件？您如何看待我们的分类？在下面的评论中告诉我们更多！

祝您技术文档好运！
ClickHelp小组
跨平台和设备编写，托管和交付文档

ClickHelp LLC（@ClickHelpNews）| 推特

最初发布在 clickhelp.co上 。