共计 1695 个字符，预计需要花费 5 分钟才能阅读完成。
我是 Postman 凋谢技术打算办公室的负责人，最近，在一次 Postman Open Technologies 团队会议上，我提出了一个十分抽象的方向：咱们必须成为以文档著称的团队，并须要集体和团队独特记录所有内容。 尽管还有更多背景信息，比方咱们与产品团队的合作等等，但这也是我给本人以及其余从事工程、OSPO 或开发者关系畛域工作人员提供的通用倡议。
首先让咱们定义“文档”这个词。在本篇博客文章中，“文档”包含内部和外部技术文档、博客、社交网络分享常识、演示、操作指南、会议报告、网络研讨会、播客节目、维基 百科 页面、信息图表 等等。
我了解在当今快节奏的世界中容易迷失于各种职责。然而，尽管编写文档不像编写代码、设置流程或解决问题那样能立刻取得回报，但 创立良好的文档是向四周人以及将来本人展示同情心的体现。它的影响是中长期的，但须要当初优先思考。 我认为，文档高手最终会成为人生赢家。以下是 10 大理由。
- 理由一：记录让你成为更好的共事和协作者
创立良好的文档能够缩小挫败感，升高合作带来的焦虑程度，并使以前的决策更易了解。
- 理由二：记录减少了你的价值
它进步了你作为专业人士的价值，并使你不那么容易被取代。放弃一个外部常识治理做的很好的人或团队，是苦楚的。雇用一个以构建长久常识而闻名的人，是理智的决定。
- 理由三：记录有助于建设集体品牌
在进行钻研时重复遇到雷同作者名称，会使你成为主题专家。再加上其余措施，如社区参加、领导、公开演讲等——将极大地帮忙你打造本人品牌。
- 理由四：记录减少了外部可见性
可能援用本人编写的货色，比模糊地反复在团队会议上说过什么要容易得多。如果很容易做到这一点，共事们更有可能给予赞美。
- 理由五：你能够把它切割成内容创作块
一旦开始记录货色，就能够将其切割并制作内容创作块。制作视频、撰写播客叙述、筹备演讲或邀请具备类似或不同观点的人加入小组讨论比从头开始要容易得多。它还能够帮忙你找到故事线索。
- 理由六：记录有助于内化你的常识，并辨认注意事项
反复，这就是人脑的工作形式。写下来正好合乎此状况。当你打字速度比大脑解决信息快时，你强制本人重复反复同样的事件，有助于你内化发现后果，或帮忙你在思考中找到陷阱和谬误。
- 理由七：记录使你的常识长久存在
你是否已经遇到过一个书面材料，并想，“嘿，真是很好的常识，我很快乐他人把它写下来了！”但突然发现，这些文档就是你本人两年前写的！咱们会遗记，甚至这也是咱们学习过程中所蕴含局部内容之一。存储信息不仅仅是为别人而做某些事件，同时也为本人做某些事件。即便你不定期更新内容，它在一段时间内甚至可能超出预期。
- 理由八：记录节省时间
你可能认为恰恰相反，编写文档会占用大量工夫？你有没有感觉本人在反复本人？这可能是因为你的确如此做了。当你编写文档时，它能够防止让你重复解释同一件事件的繁琐工作。
- 理由九：助于防止难堪的询问
如果一周内，你间断三四次解释同一个老问题，你会感到无聊，你的共事也会难堪，他们也会因节约你的工夫而感到惆怅，也可能会因感觉你太繁忙而退缩，这会障碍合作。
- 理由十：记录让你更善于讲述
整体状况是你将被要求提供的内容，不仅可能提供事实和数字，还可能很好地讲述并使数字深入人心，这是最为宝贵的。
须要留神的是，尽管我说“好文档”，但我并没有要求“优良”或“杰出”。不是因为我认为永远不会有完满的货色，而是因为文档没必要白璧无瑕。通常，“一般文档”就足以胜任工作，并且在致力和效益之间达成了正当的斗争。
每当须要文档时，你都要动摇地说：来吧，写吧！
Eolink 翻译, 原文《10 reasons why you have to exceed at documenting》，作者：Jan Schenk
【编译后记】
编译实现后，我发现作者这篇文章能够组织得更好，比方从集体、组织、共事合作三个角度对 10 个理由进行分类，会更好。否则 10 个理由是有认知累赘的，记住 3 个方面的理由总要比记住 10 个容易得多。
一百年前，鲁迅曾批评文化“十景病”、“八景病”，总要凑到十个或者八个，当初看外国人也不能免俗。如果用在风景名胜，十个八个听起来嘹亮，但技术文章未必要这么做，清晰的分类更重要，太多反倒是认知累赘。