内部文档：您需要知道的一切（提示和教程）

已发表: 2022-07-04

您的企业需要内部文件吗？什么是内部文档？

虽然您可能熟悉创建文档以帮助您的客户从您的产品或服务中获得更多价值的想法，但高质量的文档也可以帮助您的企业和员工更好地工作。

这种面向内的文档称为内部文档，您可以使用它来提高生产力、保存和共享知识等等。

在本指南中，您将了解您需要了解的有关内部文档的所有内容，包括以下内容：

什么是内部文件
内部文件的好处
内部文档最佳实践
如何创建自己的内部文档中心

什么是内部文档？

内部文档是贵公司程序、知识、最佳实践等的结构化集合。

在贵公司的整个生命周期中，贵公司将积累大量的知识和专业知识。内部文档可帮助您将所有这些集体知识保存在一个易于访问的中心。

您可以使用它来提高生产力、防止知识流失、新员工入职等。

让我们分解一些关键概念……

内部与外部文档

内部和外部文档都服务于记录流程、解释如何做事、共享关键知识等相同的目标。

主要区别在于该文档的目标受众是谁：

内部文件——目标受众是贵公司的员工。
外部文档——目标受众是您的用户、客户、客户等。

基本上 - 客户或一般的外部人员永远不应该看到您的内部文档，但您的员工可能会依赖内部文档来完成他们的工作。

不同类型的内部文档

我们在上面已经谈到了这一点，但是有不同类型的内部文档，您需要根据其特定目标对每种文档进行定制：

流程文档——您需要记录如何正确执行某些任务。这可能包括清单、教程等。例如，您可能有一篇关于“如何创建新的内部文档”的文章。
项目文档——您需要记录每个项目的详细信息和进度。这可能包括提案、业务案例、会议摘要、时间表等。
政策/人力资源文档——您需要记录重要的政策，例如员工入职、休假政策、病假、员工离职等。
团队文档——每个团队都可以为团队特定的知识和政策创建自己的内部文档。例如，您的内容团队可能会记录博客风格指南和使用访客海报的政策。
技术文档——如果你有一个开发团队，他们会想要创建自己的内部文档来解释代码中发生的事情、样式指南、QA 测试策略等。

内部文档的好处：为什么值得努力？

创建内部文档无疑需要一些额外的时间，而不是“只是临时做”。

那么内部文档有什么好处呢？也就是说，为什么值得投入时间和精力来创建内部文档？

以下是一些最大的内部文档优势：

促进知识共享——您可以鼓励员工分享知识。更重要的是，员工可以轻松访问其他员工共享的知识，而无需每次都直接与原始共享者交互。
提高生产力——通过记录重要的流程和细节，您可以确保员工不会不必要地陷入困境，从而提高您的整体生产力。
更有效地加入新员工——当新员工加入您的公司时，他们将能够依靠您汇集的内部知识来快速跟上进度。
保留知识——在某些时候，关键员工会永久离开或因休假/生病而离开。拥有内部文档可确保这些员工的知识即使在他们离开时仍然得到保存和访问。

创建高质量内部文档的最佳实践

既然您知道内部文档是什么以及为什么它很重要，那么让我们开始着手研究如何实际创建自己的内部文档中心。

我们将从一些通用的内部文档最佳实践开始，然后我们将介绍创建您自己的集线器的技术流程。

让关键利益相关者参与进来——内部文档不应该只是使用自上而下的方法——重要的是让每个级别的关键员工都参与进来。毕竟，这些员工通常是那些拥有您想要保留的“深入了解”知识的人。您可能还希望指定特定员工作为内容策展人，以便有一个明确的决策者。
重新调整任何现有文档的用途——您不需要从头开始构建整个内部文档，因为您可能已经将现有内容隐藏在各个位置。尝试将这些内容重新用于一个中央集线器，以使其更易于访问。
使其易于访问——谈到易于访问，您希望确保您的中心易于浏览和搜索。使用即时搜索建议等类别和功能来帮助引导员工访问相关内容。
为一致性创建一个风格指南——如果你所有的文档都使用不同的格式，人们就很难从中获得价值。为避免这种情况，请预先创建样式指南，并为每条内容遵循该指南。
包括图像、视频和 GIF——不要仅仅依赖于文本——包括图像、视频和其他媒体（如 GIF）可以使您的内容更有用。例如，在记录某个过程时，您可以包含记录该过程的图像或视频。
避免过度记录- 虽然内部文档有很多好处，但过度记录也会导致挫败感并惹恼您的员工。在记录重要细节和让员工忙于工作之间取得平衡很重要。
保持一切更新——您的流程和机构知识会随着时间而改变，因此更新您的内部文档以跟上这些变化是很重要的。同样，将员工指定为负责随时间更新您的内部文档的利益相关者可能会有所帮助。
征求员工的反馈——请记住，您的内部文档是为了让员工的生活更轻松。不要害怕向员工征求反馈，因为他们可能对如何提高你的内部知识有一些很好的想法。

如何创建您的内部文档中心

现在是最后一个问题——您如何实际创建所有员工都可以访问您的内部文档资源的中心？

好吧，在知识库软件方面，您有三个主要选择：

使用 WordPress 和 HeroThemes 等开源软件。
使用 SaaS 工具。
编写您自己的解决方案。

虽然我们可能有点偏见，但我们认为 WordPress 的开源方法很有意义，原因如下：

您对您的文档拥有完全的所有权和控制权。您的文档可能包含您不希望放在其他人的服务器上的敏感信息（如使用 SaaS 工具）。使用 WordPress，您可以将所有数据和信息保存在自己的服务器上。
还是很简单的。如果您使用像 Heroic Knowledge Base 这样的 WordPress 插件，您可以在很短的时间内启动并运行，而如果您开发自己的解决方案则不太可能出现这种情况。
它具有成本效益。 WordPress 方法通常比 SaaS 工具便宜很多。摊销一年后，您通常每月为无限文章和无限用户支付不到 15 美元的费用。

以下是使用 WordPress 和 Heroic Knowledge Base 插件创建内部文档中心的方法。

1. 设置 WordPress 安装

首先，您需要创建一个全新的 WordPress 安装程序作为您的内部知识中心。

您有两个 WordPress 安装选项：

您可以创建一个只能从您公司的本地网络访问的 Intranet 站点。我们有关于设置 WordPress 内部网站的指南。
您可以创建一个可从任何地方访问的公共 WordPress 站点，但使用密码和/或员工用户帐户限制访问。有许多插件可让您创建用户帐户或仅通过可以与员工共享的单个密码来限制整个站点。

由于现在远程工作很流行，您可能希望采用第二种方法，这样员工即使不在办公室也可以访问内部文档。

2.安装英雄知识库

安装 WordPress 后，您可以添加 Heroic Knowledge Base 插件，将其变成内部文档中心。

Heroic Knowledge Base 是一个 WordPress 插件，它为 WordPress 添加了完整的知识库功能。它包括许多使您的内部文档中心成功的功能：

即时搜索建议，引导员工找到相关内容。
无限类别按主题、部门等组织内容。
内置反馈工具，使员工可以提供有关文章的反馈。
通过 WordPress 的内置版本控制系统轻松进行版本控制和修订管理。这对于查看文章如何随时间变化（并在需要时恢复更改）非常有用。
内置分析可查看员工最感兴趣的内容。您可以使用此信息来完善和优化您的文档。
帮助助手小部件为员工提供了另一种查找相关文档的简便方法。

购买 Heroic Knowledge Base 后，您可以像安装任何其他 WordPress 插件一样安装它。然后，您将获得一个易于使用的设置区域，您可以在其中配置有关内部文档知识库的所有内容：

或者，您也可以使用 KnowAll 主题，该主题处理文档中心的设计，同时还构建了 Heroic Knowledge Base 插件的所有功能。

3. 添加您的文档文章

安装 Heroic Knowledge Base 插件后，您就可以开始添加内部内容了。

借助 Heroic Knowledge Base，您可以使用灵活的 WordPress 块编辑器来做到这一点。

Heroic 知识库还添加了一些专用块来帮助您增强文档。例如，您可以轻松添加标注或警告以突出显示要避免的关键信息或问题：

您还可以添加无限类别来组织您的内容。

要更改文章和/或类别的顺序，您将获得特殊的拖放界面。您可以通过转到Heroic KB → 文章排序或Heroic KB → 类别排序来访问这些：

立即创建您的内部知识库

虽然创建内部文档确实需要投入时间来创建内容，但当您能够保存和共享知识、提高生产力并更有效地招募新员工时，这种投资就会得到回报。

对于设置内部文档中心的最简单方法，您可以使用开源 WordPress 软件和 Heroic Knowledge Base 插件。

通过使用 WordPress 和 Heroic 知识库，您将获得以下好处：

对您公司的数据拥有完全的所有权和控制权，因为一切都保留在您的服务器上。
降低成本，因为您只需支付一笔低廉的固定费用即可无限次使用。
简单，因为 Heroic 知识库提供了您需要的所有功能，无需从头开始编写自定义解决方案。

立即设置您的内部内容中心，您将立即受益。