一般的 IT 公司都有需求、任务跟踪器的历史记录、来源（甚至可能在代码中包含注释）、生产中典型、重要和复杂案例的说明、业务流程的描述（从入职到“如何去度假”） ”）、联系人、访问密钥、人员和项目列表、责任范围的描述 - 以及一堆我们可能忘记的其他知识，这些知识可以存储在最令人惊奇的地方。
知识=/=文档。 这无法解释，必须记住
如何确保那些需要从中了解信息的人知道在哪里以及如何找到它，并且每个需要了解个别事物和协议的人都可以立即准确地了解其中的变化。
在“Team Lead Will Call”播客的最后一集中，Skyeng 的人员与 Igor 谈论了知识管理 Tsupko 是 KnowledgeConf 项目委员会的成员，也是 Flant 的“未知总监”。
完整录音可作为 ，下面我们收集了一些有趣的提示和链接，链接到音频中提到的有用材料或扩展其中的信息。 如果您也在评论中分享您团队的技巧和窍门，那就太好了。
第一个技巧：您不再需要知道要查看哪个系统
“我获取了我们的知识源并对它们进行了一般搜索：带有过滤系统的单个窗口以缩小搜索范围。 是的，与此同时，您仍然需要监控其质量，补充知识库，并打击重复和错误信息。
一张纸就能找到一切
但目前，大约 60% 的 Flant 工程师每天至少使用此搜索 1-2 次，并且通常在第一或第二位置找到答案。 概念验证的形式是 Google 文档的索引：所有 dox、文件夹、货车驱动器等 - 所有这些也很容易进入内部搜索。”
第二个技巧：如何在一堆聊天中不错过至关重要的事情
“如果你在分布式团队中工作，那么你一天的很大一部分时间可能都花在 Slack 上 - 在这种情况下，你习惯于做这样的事情：“@myteam，帮助/查看/输入正确的... ”。” 但信息丰富存在一个问题——在其他消息中可能会遗漏单独的提及。
在 Skyeng，我们得到了一个机器人的帮助，您可以通过它编写消息并标记任意数量的人员或群组。 我们在人们阅读或做出反应非常重要的情况下使用它：它会无休止地戳戳，直到你按下“我读”按钮 - 你将无法跳过或忽略它。”
要回答的问题：如何处理文档？
“很多知识都来自技术人员，但并不是每个人都知道如何很好地描述它们。
毕竟，您没有任何编译器或 linter 可以告诉您是否做得正确 - 而且我们的输出通常是难以理解的、格式不正确且不完整的文本。 当然，你需要正常地做，而不是因为有人过来说“这是必要的”——你自己做的很好：一两个月后你就会读它并理解。 而另一个人，打开一个文档，不会立即永远关闭它，意识到它是无用的。
播客的一部分专门讨论“需要多少人才能编写良好的文档或制作正常的演示”
但问题仍然存在：为此分配多少时间以及如何有效地完成它？
如果这里有一个诚实的答案：除非业务人员参与其中，并且除非他们凭经验体验到良好文档的影响，否则这种努力可能会产生很少的回报。 这更多的是一个关于改变文化的故事。
对于其余的，经验和指导将拯救你。 结对编程、进度跟踪和代码审查的类似方法可能适合这里——展示最佳实践、找出错误并最终感到无聊。”
额外奖励：“好吧，我会这样告诉他们，他们会理解的”
“在这方面花费多少时间以及在什么级别上这样做”的问题不仅在文档框架内很重要，而且对于任何知识的转移来说通常都很重要。 该演示也是共享信息的一个很好的例子。 但也存在一些细微差别：例如，如何确保它们占用最少的时间。
开发间的知识共享渠道：内部报告、有用的书籍、文章等。 结构化摘录也存储在 Notion 中。
这些问题在一定程度上可以通过内部报告的做法来解决。 每周一次，他们会在不太忙的时间花 40 到 60 分钟，为来自不同项目的同事制作视频报告。 重点产品Vimbox前端团队- 关于您的 UI 套件，它可以为任何其他项目设置主题。 营销开发团队谈到了一个用于跟踪和记录请求的库，这立即引起了其他几个项目的兴趣。 数学项目团队分享了他们从 REST API 切换到 GraphQL 的经验。 小组课程团队正在考虑分享他们是如何第一个切换到 PHP 7.4 的。 等等。
该名单自 2018 年 120 月起维护，共有 XNUMX 多个条目
所有会议均通过公司 Google Meet 开始、录制并在 1.5 小时内出现在共享 Google 驱动器上的文件夹中，并且指向录制内容的链接会在同一个 Slack 中复制。 也就是说，如果有紧急情况你不必来，而是稍后以 20 的速度观看 - 通常报告本身持续长达 XNUMX 分钟，以及讨论 - 结果如何。 但我们不会超过这个时间）
PS 什么对你有用，什么没用？
相关链接：
- 卡巴斯基实验室的 Rodion Nagornov 关于 以及为什么这不是文档（感谢 Igor 的频道提供的链接 ，类似的还有很多）。
- 来自 Flant 的 Igor Tsupko 对此的看法 在我公司
- 来自 Skyeng 的阿列克谢·卡塔耶夫 （技术和特定领域的知识差距）在分布式团队中。
- 来自 Flant 的 Sergey Goncharuk 关于传达信息 - ，如果你在分布式团队中遇到问题。
来源： habr.com