内部、外部、产品、流程、技术和用户文档

您是否总是需要澄清涉及不同类型文档的许多术语？请查看以下问题。

手册和用户文档是什么意思？什么是用户手册？编写用户手册算不算技术文档？培训手册和说明手册有什么区别？外部和内部文档？产品和流程文档？

在这里，我们将以最合理的方式对所有这些相关术语进行分类和定义，以便您了解它们的相似之处和不同之处。但是，文档术语可以互换使用；我们也会介绍它们。所以，让我们从定义这个主题中最通用的术语开始：

文档

文档是一种可传达的材料，它正式提供有关系统、产品、服务、组织、程序或技术流程的介绍、描述、培训和指导的信息。在许多情况下，这些正式的信息性文件也称为手册。

让我们进入下一个级别。

在讨论产品或服务时，良好的分类可以将文档或手册分为两大类：技术文档和用户文档。另一个类别可能将文档分为产品文档和流程文档，类似于第一个类别。对文档进行分类的另一种合理方法，尤其是关于组织设置的方法，是根据内部或外部来组织文档。

我们将对所有这些问题进行讨论，并从最广泛的问题开始。

外部文档

从名称上就可以看出，外部文档旨在与组织（公司、业务部门等）外部的人员共享，以提供有关产品或服务的信息和指南。因此，外部文档也可以称为产品文档。公司的外部/产品文档可以分为用户文档和系统文档。

A. 用户文档

用户文档，也称为最终用户文档，旨在为最终用户提供有关产品或服务的全面信息。此类文档也可称为用户帮助。其主要目的是为用户提供有关产品的有用信息，例如一般介绍、描述其功能以及安装、使用和维护说明。

这一类手册通过一些技术解释来教授主题。不过，由于目标是最终用户，它们必须限制详细的技术信息，并使用简单的语言和标准术语和表达，而不是技术术语。因此，它们提供了用户友好的指南和分步说明以供实际使用。因此，虽然用户文档属于技术作家（使用技术信息、理解技术信息并将其翻译成更简短、更简单的内容供最终用户使用）的范畴，但它并不总是被视为技术文档。因为它们通常不针对专家和专业人士。我们将在本文后面讨论技术文档。

让我们回顾一下不同形式的用户文档：

• 安装和设置手册
  • 安装和设置手册包含有关安装、设置和启动产品的详细信息。
• 使用说明书
  • 指导用户如何正确使用产品的手册。
• 故障排除手册

  • 解决如何解决产品常见问题的手册。

• 用户手册
  • 典型的用户手册通常将上述所有指南集中在一起。用户手册针对不同的用户（包括熟练用户和非熟练用户），提供有关产品设置、操作和维护的说明。它们向用户介绍产品并概述其标准功能及其不同特性和应用程序。它们通常包括有关使用产品的注意事项，也可能包括基本的常见问题解答和故障排除。

B. 系统文档

系统文档可能以服务手册或维修手册的形式出现。系统文档包括底层系统概述、更详细的技术信息和维修说明，以帮助机械师、工程师和其他高级用户维修产品。

内部文件

内部文档不是为了对外共享。它包括技术细节和组织政策、程序等，这些对于用户来说是不必要的或没有用的。通常，此类文档可作为员工、技术团队、经理或其他办公室工作人员的参考，以更高效地完成工作。如上所述，内部文档可分为技术/流程文档和组织支持文档。

A. 技术文档

当我们使用术语“技术文档”时，我们指的是主要在组织的技术团队中分发的内部文档。它们涵盖测试计划、开发流程、设计规范、项目计划、系统维护和改进等主题，以及许多技术术语。术语“流程文档”几乎指的是同一种文档。技术文档和流程文档可以互换使用。

B. 组织支持文档

在任何组织中，都有不同的手册和文档用于培训员工和定义内部组织准则，并且大多数这些文档都属于人力资源领域。让我们讨论一下您在组织中遇到的一些最常见的手册相关术语：

1.操作手册：

该手册包含公司的标准和指南，概述了应该做什么和如何做。因此，它可以帮助员工更正确、更有效地完成工作，特别是在商品和服务的质量和安全方面。

2.危机管理手册：

它是指导员工如何应对工作场所危机的手册。

3.审计手册：

它描述了公司的审计政策和程序。

4.培训手册：

培训手册主要用于改进所执行的任务，并可能包括培训员工的指导。培训手册可作为初学者和熟悉/有经验的员工的参考指南。

5.政策手册：

政策手册或政策和程序手册通常是经理和主管的良好参考资料，可帮助他们做出决策并有效经营业务。它包含所有公司指南、规则和政策，以及遵循这些政策和标准的具体程序。

6.组织手册：

它定义了组织结构，包括有关组织职位、任务、职责、职位描述、责任、关系和层次结构的所有信息。因此，它可以帮助员工更好地了解和履行自己的工作职责。

指南

那么，什么是指南？

与我们讨论的手册术语相比，指南是一个更通用的术语，指任何带有指南和帮助的手册。指南不一定是关于使用产品的。用户指南不必全面，可以像卡片一样简单，为用户提供一些有用的说明。  

结论

组织的文档可以用不同的方法进行分类。一种方法是决定哪些文档将在外部共享，哪些不会。详细的技术和公司政策和程序不打算在外部人员之间传播。另一方面，系统和用户文档可以帮助用户根据需要了解公司的产品。那么，让我们快速回顾一下要点：

用户文档主要包括以下内容：

• 使用说明书
• 安装手册
• 故障排除手册
• 用户手册

用户文档目标是：

帮助用户了解产品以及如何：

• 安装
• 操作
• 故障排除
• 让用户远离可能的危险

技术文档主要涵盖：

• 测试计划
• 技术设计规范
• 项目计划

技术文档目标是：

保存组织的技术流程和入职技术人员的记录，以便：

• 发展
• 测试
• 维护
• 改进