Mailbag:如何鼓励良好的文件而不是完美的文件?

2021年2月15日。提起申请员工 - 艺人10.邮袋6.

一个伟大的问题员工工程师that I received recently:

当您编写文档(并审查它们)时,我真的被激励推动他们的理念,而且不完美。好奇是你如何促进超越自己的文化?我觉得自从我们转移到远程文化,Doc Grooming已经达到了一段时间。如果这是你觉得的东西,也很好奇?

书面沟通是“明显最佳”的沟通文化的越来越普遍的信念。这最初是由之驱动的亚马逊的文化出口memo culture,并且最近通过堤防驱动的转变向远程工作而被摇晃。我对书面沟通很少,但这是一个具有挑战性的转变。这个问题在某种程度上打击了这一班次可以争吵:强调完美而不是促进讨论的好速度。

这是工程团队的一个相当熟悉的问题。它经常在系统设计中,在张力之间yagni而不是希望在六个月内重写系统。甚至更常见的是,大多数工程师都在一个团队上,在代码审查期间对NIT采摘反馈的感知导致在该方法估计超越改变之后仅共享拉动请求。

代码审查的示例可能是最熟悉的,因此我们可以考虑调试牌照审查流程的策略如何应用于编写文化:

  1. 人们隐藏工作,因为他们是不舒服的。If documents are being shared late, it’s because some aspect of the sharing process is making authors uncomfortable. Usually this is because the feedback they’re receiving isn’t helping them accomplish their goal. Maybe there’s too much feedback and folks are waiting until late to share to minimize responses. Maybe the feedback isn’t useful, so folks don’t bother requesting feedback until they’re past the point of cheaply incorporating new ideas.
  2. 贵公司可能有四个人,让文件不舒服。在开始思考这个问题的系统级别解决方案之前,我想有一个非常少数人需要直接教练如何提供有关文件的反馈。如果您认为它们对他们如何与其他人互动的文件负责,可以想象可能足以解决整个问题。
  3. 提供结构化模板和文档生命周期。灵活的文件模板将消除关于结构问题的争论。文档生命周期过程将清除何时提供哪种反馈。模板和生命周期在代码审查中的代码LINTER,远离风格和物质的反馈。
  4. 有一种审查文件的可教技巧。如果您要求某人编辑文件,则会令人惊讶的人数将立即倾向于调整词语或提供语法反馈。有时这是有用的,但通常不是。虽然工程师在频繁重复时往往会在代码审查中变得更好,但大多数人都没有足够的文件审查以获得善于效果。幸运的是,这是一个可教的技能。在留下任何评论之前,让人们读一次整个文件一次(避免可怕的“但是稍后解决了......”响应)。对思想的反映反馈而不是格式。
  5. 提供指定的友好审阅者/写作教练。更进一步的是,大多数人都没有太多的经验写文档!您可以通过提供写作教练来减少分享文件的感知风险,可能是他们所在地区的经验丰富的工程师,他们可以提供非常早期的反馈。这位教练也将处于一个很好的位置,以便在“足够好”而不是继续抛光它时,向人们发货。该人还为分享文件的人提供“社会证明”,借助他们作为作者的高级工程师的特权,他们的文件确实已准备分享。
  6. 提供具有正确质量水平的“金色文件”的存储库。I bet you already have a list of “example documents” that folks should emulate, and I bet they are absolutely incredible documents. Which is to say, that they are absolutely not the example you want folks to follow if there is too much emphasis on perfection. Create a new list of “golden documents” which aren’t necessarily the best documents but instead those at the correct level of quality. Ideally you should even acknowledge the documents which are “too good.” Yes, they’re beautiful, but no, that’s not what we’re trying to do here.

在所有这些事情中,我认为最有效的方法是自己延续“良好而不是完美”的行为,推动其他领导者模型的行为以及借给您在发布不完美工作时承担更大风险的作者的缺陷。