为组织建立有效的内部 Wiki

Avatar of Author
Tal F.
on November 02, 2021 · · filed under Documentation Portals Technical Writing Product Documentation Tutorials Internal Documentation

建立内部维基对企业的许多方面都至关重要。在本文中,我们将讨论维基是如何开发的、其用途以及为什么它们对你的组织很重要。

什么是内部维基,为什么企业需要内部维基?

公司的内部维基是一个专门的位置,团队可以在这里存储、查找和相互交换重要信息。可以将其视为企业的长期记忆或内部知识库。企业利用 wiki 来记录公司运营的重要信息,如公司政策、程序、流程、技术说明(发布说明和其他故事描述)、项目计划以及培训和入职文档。

企业维基消除了多余的查询,使员工能够独立运作。此外,它还能防止企业流失--维基保存了可能丢失的信息。

此外,维基还能对组织文化产生有益影响。员工必须提高写作技巧,简洁明了地表达自己的观点。通过更清晰的写作,你可以更清晰地思考,从而提高团队合作和工作效率。

在选择支持公司内部维基需求的维基创建平台时,你应该注意平台的哪些关键功能?

你的公司将根据你的具体要求定制你的 wiki 体验。不过,以下要素对你的 wiki 体验至关重要。在为你的组织选择内部维基时,确保它具备这些特点。

你的 wiki 应与你的团队目前使用的技术无缝集成。

你的团队已经在使用 Github Gist、Air table 等平台以及 Google Sheets 等文档编辑器交流和共享信息。因此,你们的集体知识分散在少数几个应用程序中。您的员工必须不断切换工具,才能访问关键的企业信息。

虽然内部维基可能会有所帮助,但事实上,你团队的一些重要知识仍将受制于维基以外的其他技术。这就是为什么在为企业选择合适的 wiki 时,拥有一个能与企业技术相结合的 wiki 创建工具至关重要。

搜索工具应坚固有效。

一个强大的搜索工具(我们在 Docsie 使用的就是这种工具)能让用户快速找到资料,而无需翻阅文件夹或主题。

至少,你的维基搜索功能应该像谷歌的一样快速、直接。

Docsie 的搜索功能可以让我们的用户快速高效地查找内容和知识。只要输入要查找的单词,所有文章及其位置就会出现:

考虑一下 Docsie 的搜索功能。Docsie 使团队能够集中存储、组织和分发重要信息。他们依赖我们的平台来帮助他们快速找到所要搜索的内容。这就是为什么当你点击 Docsie 中的搜索框时,我们会显示你最近阅读过的文章--因为你要找的文章肯定是你刚刚访问过的文章。

此外,我们还提供分面搜索功能,帮助您完善搜索。例如,您可以在文档和各种文章中找到对 "Javascript "一词的引用:

快速而强大的搜索功能不仅可以减少搜索信息所花费的时间。此外,它还能为你的团队提供良好的用户体验,提高他们使用的可能性,并为你的 Docsie 维基添加出色的功能。

协作能力

内部维基消除了每个拥有众多团队的组织中自然存在的知识孤岛。不过,团队应在维基上保留自己的专属位置。

团队可以通过使用 Docsie(其他维基类型文件夹)书架中的书籍来做到这一点。例如,工程团队和市场营销团队都有自己的专门主题。此外,每个团队还可以开发嵌套子主题。例如,每个品牌和增长团队都可以在市场营销主题内建立自己的子主题。

无论这些专门的场所被命名为什么,它们都应能让人们在正确的时间、正确的人面前轻松获得适当的信息。

Docsie 允许与你的团队进行无缝协作。以下视频展示了 Docsie 的一些协作功能。

观看视频此外,Docsie 还允许您在平台内设置各种角色,这对于规定谁能做什么以及能做什么非常重要。

下面是我们如何在 Docsie 中定位用户角色的示例:

协作极其重要,尤其是在大多数团队都是远程工作的时代。要了解有关 Docse 如何帮助实现协作的更多信息,请 点击此处

维护最新和正确资料的方法

某些维基站点在确定资料是否是最新的和正确的方面具有挑战性。寻找能显著显示关键信息的维基,如帖子的日期和作者。

谁最后修改了你的维基内容?

如果你想知道文档的最后修改时间,那么拥有一个能显示时间戳的平台是关键!通过 Docsie,我们的所有用户都可以看到各种书籍中的内容,这有助于他们了解哪些工作还需要完成。

组织良好的内部维基平台的关键要素是什么?

有效组织

为了存储和组织材料,文档编辑器使用传统的文件夹,也可以有文章和子文章、标题和各种布局配置,这有助于更有效地管理内部维基的布局。然而,如果没有适当的文档组织,大多数时候查找这些文件和知道哪个文件属于哪个部门都会很乏味。这就给同事查找和保存信息带来了困难。

平台的搜索功能可以让不同团队和部门的同事快速有效地找到相应的文件。此外,将信息划分成册和书架,还能使组织的内部文件更加有序。

下面是 Docsies 工作区的一个示例。正如你所看到的,我们已经将文档整理成书和书架。书籍是文章,而书架则是专门定制的知识门户中不同文章的集合。

保持格式一致,便于阅读

文档应该简单明了。如果您的团队有更多的格式选择,文档体验就会变得更加繁琐。如果每个人都可以随心所欲地编排自己的文章,那么维基体验就会变得参差不齐、令人困惑。如果你有一个简单易读、易于遵循的格式,那么它不仅易于开发和维护,而且还能更快、更有效地在一个结构简单、设计一致的框架内开发文档。

下面是 Docsie 开发的用户指南示例。这是我们的帮助门户,它将帮助你了解什么是有用的动态格式。

1. 主要写作区域: 最好有图片和图表,以及能最好地解释文档的文字说明。位置要好,大小要合适,标题和标题的位置要好。

2.功能齐全的搜索导航:这一点非常重要,可以加快读者找到合适信息的速度。

3.链接: 链接是引导读者浏览其他必要页面的关键。

4.目录: 这可以让读者在知识门户和内部文档中找到具体的文章。

5.语言和版本选择器: 读者可以更换语言,这对于拥有大量海外员工和不同国家员工的公司来说至关重要。

搜索不仅仅是一个顺便的想法

当您编写的文档数量有限、员工人数较少时,快速找到正确的信息可能不成问题。但是,随着团队的壮大,为内部知识库做出贡献的人越来越多,你就会意识到这些文档编辑器的局限性。

大多数内部文档并不适合拥有众多员工的成长型内部维基站点。拥有一个动态搜索引擎和一个组织良好的 wiki 对于保持工作流程的顺畅至关重要,这样员工才能在搜索文档时找到所需的有用信息、政策、用户指南和教程。

自托管维基和云维基,哪个更适合你的组织?

现在让我们来谈谈如何发布文档,是自托管维基好,还是基于云的专有维基好?

我们先来看看每种选择的利弊。

自托管 Wiki。

如果你有足够的资金和资源,你可以将企业维基托管在自己的内部网、服务器或互联网托管服务提供商上。**.自托管维基的优点如下:

  • 你是数据的唯一拥有者。

  • 你可以根据自己的要求和规格设计维基体验。

不过,自托管 wiki 需要消耗大量技术资源。通常情况下,它最适合具有非常专业化要求的团队。

Wiki 托管在云端。

例如,Docsie 可以让你在不投入大量技术资源的情况下创建内部维基。在一个工作日内,你就可以启动并运行。

它易于管理和使用。此外,只需一行代码,它就能轻松嵌入贵公司的网站,这将使它与贵公司的品牌外观和感觉无缝融合,带来舒适的整体用户体验。从长远来看,使用 Docsie 通过我们的门户网站或在贵公司网站上嵌入 Docsie 网页来帮助您托管您的文档,从长远来看将节省时间和金钱,并带来更充分的文档工作流程。

为信息架构奠定基础

信息结构的外观在很大程度上取决于你选择的维基解决方案。

在 Docsie 中,资料有三种组织方式:书架(功能类似于文件夹)和书籍(容纳内容本身)。因此,如果你的团队使用 Docsie,你的信息结构就是指你的主题的组织方式。

当你组织团队的内部维基时:

专注于清晰度。团队中的每个人,而不仅仅是创建者,都应该能够简单地浏览你的 wiki。利用多双眼睛,确保你的维基结构具有广泛的意义,每个人都明白从哪里获取信息。

允许团队灵活运用。允许每个团队以对其工作流程最合理的方式创建主题或文件夹。适用于一个团队的框架可能不适用于另一个团队。

导入和补充内容

建立架构后,你就可以开始向内部维基添加资料了。如果你已经有了文档(例如,DocX、Markdown PDF 和/或 JSON 文件),你应该在新维基上线前将其导入。我们可以轻松地从多种工具中导入资料,并将 Markdown 文件导入 Docsie。

此外,你还应在维基正式发布前将任何重要的新材料添加到维基中。团队在启动企业维基时通常会添加的几项内容包括员工手册和如何浏览新维基或知识库的教程。

配置集成

如前所述,你的团队很可能依赖少数技术来保存关键数据。我们发现,与其替换这些工具,不如将它们与知识库整合起来,让团队受益更多。

考虑哪些资料应该存储在维基中,哪些应该链接到维基。某些类型的资料属于维基以外的工具。例如,使用 GitHub 的工程团队可以使用 Docsie 同步标记符文件,并包含来自 GitHub 的错误和拉取请求。这样,用户可以继续使用 GitHub 工作流程,同时毫不费力地添加到公司的 wiki 中。

Docsie 允许用户在我们的平台上集成其他各种 SaaS 解决方案。我们允许用户集成

要了解有关我们如何将其他技术与 Docsie 集成的更多信息,请 单击此处

创建启动计划。

现在,你可以开始规划发布计划了。你需要做出一个关键决定:首次推出仅限于一个团队,还是横跨整个组织?

针对特定团队:如果你想向一个团队开放维基,那么该团队将有机会沉浸在产品中,并开始开发自己的信息架构。然后,随着内部维基的发展,最初的员工可能会提供宝贵的见解和帮助。

全公司范围:如果你选择在整个公司范围内一次性部署你的 wiki,请确保每个人都了解管理授权知识库的程序。否则,建议您从一个团队开始,然后扩展到各部门,甚至进一步扩展。对于全公司范围内的推广,我们主张聘用团队大使。他们将发展成为产品专家,并能在各自的团队中发挥带头作用。

最后的想法

贵组织的内部 wiki 不仅仅是一个假期政策的存储库。你的维基有助于培养写作和信息共享文化。

然而,选择什么样的 wiki 意义重大。选择一个能够简化和精简文档的 wiki。不应该要求任何人为了很好地掌握你所分享的知识而跳来跳去。因此,我们建议建立一个深思熟虑的内部维基,这是以战略和方法的方式分享信息的好方法,有助于保持强大的公司士气。


Subscribe to the newsletter

Stay up to date with our latest news and products