开发人员的公司知识库通常存在问题-它要么变成一个空白，因为没有动机去填补一个负责任的人，或者没有一个充满苏联公寓内物品的阳台，每个人都做出了贡献，但是他们随便写，信息很快就过时了，并且它并不总是有时间更新。
如何避免这种情况，或至少减少可能的成本？ 如何使您的企业基地变得温暖和灯火通明？ 我会尽力回答。
协作风格文档
这种方法是协作文档，最初是在医学领域出现的，当时患者和几位医生共同做出诊断决定。
在IT领域，一个引人注目的例子是Google Docs，Wiki，Github，它是具有内部约定并能够在项目上共同工作的任何系统。
这个想法是要尽早让开发人员，专家，评论家参与文档工作，以共同找出差距。
为什么还要这样做？
首先，减少公车因素是企业知识的瓶颈，因为知识持有者的数量趋于统一。 您需要将这些知识从开发人员的负责人，白板，票据，厨房中的对话中转移到一个单独的空间中，以便每个人都可以与他们合作并做出贡献。
其次，为了简化新移民进入项目的过程，这对于分布式团队和具有一定数量外包开发人员的团队以及具有非常特定业务领域的公司而言尤其重要，找到现成专家的机会为零。
第三，为了形成良好的企业文化，透明度“不言而喻”。 在这样的环境中，开发人员清楚地了解专业成长的要点，他可以在公司中尝试哪些其他技术以及要学习什么。
怎么办
企业知识库中的文档可以由团队的任何成员编写，需要为他们简化此机会，然后他们会觉得自己是结果的所有者-参与其中。
但是，您绝对需要一个承担信息架构师职责的人员-设置统一的规则，结构，逻辑，样式，并将文档正确放置在空间中。
事先就游戏规则达成共识，可以为团队成员提供编辑和创建文档的可能性。 最大限度地自动化这些规则-不要依赖团队，创建模板，使用标签自动标记内容，配置从存储库到知识库的上传（顺便说一下，我想为此撰写另一篇文章）。
开发人员必须确保文档不会在公司Wiki中消失，这一点很重要。
一个重要原则：内部文件的完成定义，这是对其进行修订或评论的时刻，实际上是协作的时刻。 这是它的价值，他们想花时间在上面。 不要补充-这意味着交付过程，搜索的执行安排不当或工具不方便。
这种方法的潜在问题是编辑和注释的堆积如雪球，难以跟踪，经常创建重复的文档。
为防止这种情况发生，您可以并且应该：A.将团队设置为向量，规则集并使不遵循规则的过程复杂化（例如，我们在Confluence中隐藏了“创建”按钮，并强制选择模板）。 B.明智地划定权利，并为负责信息体系结构的人员方便地配置编辑过程。
然后完美的世界将会来临
开发人员不会停止互相提问，包括愚蠢和重复的问题 。 他们不会学会自己找到知识库中的所有答案。 由于Confluence搜索索引的局限性，开发人员无法找到某些东西，而他们要求我作为信息架构师时，我们会感到内在幽默。 我们称其为基于Sveta的搜索。
尽管存在这些限制，但知识库的结构，页面的统一命名，标签的使用仍会刺激它们搜索和创建知识，例如，它们不会回答不断重复的问题。
我们应用的另一个生活技巧是始终在文档中包含业务上下文，即使它是对库或类的描述或任务的清单，也很重要的一点是要了解这对客户意味着什么。
现在练习
下一部分将讨论“如何”，可以使用Confluence的哪些内部特征（是的，我们使用Atlassian堆栈）来实现这些原理。
模式
我们为最经常编写的不同类型的文档创建了现成的模板-技术规格，操作方法，清单。 可以在管理空间面板中配置它们。 需要模板，以便开发人员在创建文档时不会在他面前看到空白页，而他已经在该部分或该部分中写了说明。 如果您希望某种类型的文档归为一个部分并在其上显示元信息（例如，这很方便，例如根据一种方案描述复杂产品或一组微服务的组件），则可以创建蓝图，这就像模板一样以最快的速度进行。
在它们中，我们设置了页面布局，标题，仅保留了几个单词，带有状态，图像，表格，代码块甚至变量的标题。
变量是预配置的内容元素，其他文档编辑器应重视这些内容，例如，输入文本或从列表中选择。
您也可以预先向模板添加标签，如果它是文档的狭窄类型，则可以将用户提及为审阅者，例如，如果名称，Jira宏的工作流程清晰明了，并附带来自Jira的票证。 我们的经验表明，模板最多可覆盖80％的任务。
页面布局
另一个重要元素是在团队空间中创建一个易于理解且美观的登录页面。 为此，我们使用页面布局以及宏Panel，Column和Section。
以下是我们的一个开发团队空间的示例。
使用友好的页面名称。 您可能知道，Confluence在同一空间中不支持相同的页面名称。 保持清晰的页面名称，例如
坏名字 Python
内部服务团队的
好名字 Python Styleguide
标签
融合对与内容索引相关的搜索算法有一些限制。 对于企业知识库而言，最紧迫的问题就是发现和建立联系。 我们在知识库中有一整篇文章，名为“如何击败Confluence搜索”，如果需要，我会在评论中分享。
为了克服这些限制，我们使用标签系统。 实际上，这些是标记内容主题的标记，以及为什么它们允许您以一种RSS Feed（按标签显示宏内容）的形式在一个地方聚合特定主题的内容。 因此，我们已经配置了主题索引。
如果数据库中已经有数百页，那么我建议您从以下练习开始：
- 在以下URL https上查看所有标签的列表：// <my-host-name> /labels/listlabels-alphaview.action。
- 在高级搜索字符串中查找所有未标记任何标签的内容：类型：页面NOT labelText：[a至z] NOT labelText：[0至9]。
您现在可以去做什么？
- 给开发人员编辑的权利，但要明智。
- 考虑一下命令空间的结构，制作一个方便的登陆页面。
- 自定义模板。
- 使用标签。
- 去编辑别人的文档或写评论，使该文档生效。