6.9 利用文档的真正力量
敏捷软件开发的一个信条是避免不必要的文档。也就是说,如果文档没有提供价值,就不要记录。为了文档而写文档是浪费时间。
这是因为我们通常要花费大量时间准备低层次的、详细的设计文档,而它们很快就会过时。更糟糕的是,这些文档通常没有读者——它们没有用于任何有用的目的,只是表明团队“生成了文档”。因为这非常浪费时间,所以敏捷团队非常认真地审查是否需要生成文档,以确保文档的确有用。
很多人把这种做法理解成“敏捷开发人员不写文档”,这是错误的。敏捷开发人员的确创建一些文档,但是他们使用务实的过滤方法保证对文档的投资是真正值得的。它必须有价值。
这让我们想到一个问题:对写作者来说文档的价值是什么?创建低层次的设计文档,简单地反映代码的细节(几乎很快就会过时)对任何人都没有意义。但是其他形式的文档可能是有价值的,即使没有明确的读者。
路易斯·巴斯德(Louis Pasteur)曾经说过“机会只青睐有准备的人”,核磁共振成像和脑电图测试证实了这一点。一项最近的研究〔17〕表明,将注意力进行内源性的聚焦,这样的心理准备可以促进灵感的闪现,即使这种准备发生时还远没有面对任何具体问题。
机遇总是青睐有准备的人。
Chance favors the prepared mind.
将注意力调整为内源性的,就像你在使用思维导图时那样,在大脑中构建一个有利于灵光闪现的状态。因此,写文档的过程比文档本身更重要。
飞行员Dierk Koenig也是我的一位读者。他曾给我发来了这样一则故事。
我在准备飞行例行动作时发现了这个现象。飞行动作的流程在飞行之前都会使用Aresti标记法提前计划和绘制好。在飞行过程中,我们应该记好这个流程,但是驾驶室会贴上有关流程的卡片,以防大脑失灵。
虽然有Visio插件帮助人们建立非常漂亮的卡片,但是我更喜欢手工制作,采用一种老套的方式。有一次我在机场制作卡片,学校的负责人推了推一名学生,指着我说:“快看,太酷了。”我不知道她为何这样想。我只是觉得自己在花费大量时间制作卡片。
但是很显然我也在“做思想准备”。
——Dierk Koenig
正如我前面所提到的(6.8节),做笔记非常重要,即使你从来不阅读。在Dierk的例子中似乎有很多元素在起作用。
- 手动制作增强了R型处理。
- 笔记/卡片的主动创建有利于为以后的活动做思想准备。
- 可视化流程和预演可以让大脑模拟(我们会在7.6节简要了解更多内容)。
诀窍31
写文档的过程比文档本身更重要。
你不必使用索引卡或者写字的纸,餐巾的背面就不错,或者一个大白板。
或许你想要花一个小时来制作播客或者视频。你可能发现这对你来说更具效力,对信息的使用者来说更迷人。它也比花一周创建冗长的文档更划算。
制作视频。
Make a screencast.
视频对传递动态信息非常有效:向用户展示如何使用你的软件执行任务,或者通过一套复杂的流程来构建对象的生命周期。这是一种既划算又愉快的方式,它让很多人(甚至远方的人)都想踮起脚尖看看你在讲些什么。
把它看做自学的另一种方式。当然,另一种学习的技术在于教别人。
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论