Overview

作为每一个人进入团队的第一件事-熟悉团队成员应具备的基础共享信息。整理成文档的形式无疑是性价比最高的。FAQ 本身作为文档，索引会是一个难点，所以推荐选择知识库组织的方式完成。

  • 目的：团队成员拥有交流或者工作的基础信息和能力。
  • 方式：提供文档知识库，引导如何找到这些信息。

原理

我一直推崇的是启发式教学，同时，我认为文档最重要的法宝是克制，看过我的文章或图的朋友知道，我只表达目标，其余省略并留下链接待自行探索。

如何引导？

所以关于方式中，引导二字最为重要。作为团队老人或领导者，明白手把手教不会有好的结果。新人也并非不会学习，故人的引导应该用在最关键的点（瓶颈），在此之前，新人应该有基本的信息了解以供交流。

可使用设置关键点的方式，并提供可以找到信息的源（链接，图片，搜索方式）。

设置关键点

参考前文的 checkpoint，与接下来的实践部分，设立关键点，让新人明白了解到哪一步即可。如果可以，通过提出问题（或场景） 的方式，push 新人思考。如：如果现在让你接手负责一个项目，你会如何做？这会让新人看文档的时候有一个目标，不至于不可满足最低标准。

克制

克制是指的文档编写的克制，没有人愿意在浩如烟海的文档中瞎踅摸。

  • 重要的地方要事无巨细的编写，但是留在文档里的可以是一个索引。（就像编程中的函数封装）
  • 实行加一减三的理念，进行添加信息时，同时也要进行减少
    • 对冗余表达进行删减
    • 对详细内容进行封装（注意不要影响表述逻辑）
    • 对过期内容留底归档

实践

Programmer Cookbook： 在这里尝试了一下

  • 目的：想学习计算机知识的人能有一个基础的信息引导。
  • 方式：编写教程的模式（灵感来源于 Google 的 K12 开源编码训练）