项目文档与敏捷开发

日期: 2012-03-26 作者:Jason Tee翻译:蒋红冰 来源:TechTarget中国 英文

敏捷文档小技巧   敏捷开发有效地降低了广泛而繁重的文档需求。虽然,这种方法并没有完全废除敏捷项目文档的需要。它只是简单地把文档从基础性的角色转换成支持性的角色。这里为您和您的团队在使用文档上提供了7个小技巧,帮助您提高敏捷开发。

  1. 聚焦现实   文档管理与制定计划并不是一回事,当然它也不是头脑风暴。当你使用敏捷框架工作时(或者其它的这类方法),你不会知道项目将随时间怎样演化,这就是为什么说高级的文档管理是一场恶梦。与用文档管理你将做什么和它可能会怎样实现相比,用文档去管理你都做了什么和是实现方法更有意义。猜测只会导致前文档的重编译。

同样,了解文档管理本身需要足够的灵活性,去适应发生的……

我们一直都在努力坚持原创.......请不要一声不吭,就悄悄拿走。

我原创,你原创,我们的内容世界才会更加精彩!

【所有原创内容版权均属TechTarget,欢迎大家转发分享。但未经授权,严禁任何媒体(平面媒体、网络媒体、自媒体等)以及微信公众号复制、转载、摘编或以其他方式进行使用。】

微信公众号

TechTarget微信公众号二维码

TechTarget

官方微博

TechTarget中国官方微博二维码

TechTarget中国

敏捷文档小技巧

  敏捷开发有效地降低了广泛而繁重的文档需求。虽然,这种方法并没有完全废除敏捷项目文档的需要。它只是简单地把文档从基础性的角色转换成支持性的角色。这里为您和您的团队在使用文档上提供了7个小技巧,帮助您提高敏捷开发

  1. 聚焦现实

  文档管理与制定计划并不是一回事,当然它也不是头脑风暴。当你使用敏捷框架工作时(或者其它的这类方法),你不会知道项目将随时间怎样演化,这就是为什么说高级的文档管理是一场恶梦。与用文档管理你将做什么和它可能会怎样实现相比,用文档去管理你都做了什么和是实现方法更有意义。猜测只会导致前文档的重编译。同样,了解文档管理本身需要足够的灵活性,去适应发生的变化。即使在最好的情况下,它也不是一劳永逸的事。

  2. 文档管理决策

  文档管理最多的工作是发生在敏捷项目的最后阶段,当然前期的注意事项记录也是很重要的。其中一个最重要的信息记录类型是这些批评得来的理由是什么。这将会避免二次猜想和稍后的决策修订。你可能会说:“我们是集体决定的,通过评测 -'xy'- 的信息,得出结论a 项选择比b 项选择要好的理由如下……”这个声明可能意味着减少回溯的工作。然而,如果它是某个时间内最好的决定的话,那这项决定在过去与现在有什么不同和改变。

  3. 用户是谁

  没有一个开发项目是完全透明的,总会有一些人是需要你去了解代码背后发生了什么。这也许就是使第三方合作者不能完全融入到敏捷环境的紧凑的团队中的原因。或者,它将会成为“未来一代”维护软件的任务。确定你的受众,你就可以正确地明确文档和减少不必要的解释。

  4. 把人才放在合适的位置

  这意味着程序员就要编辑代码,技术人员就是协助文档管理。开发人员应该做原始的文档管理并保证其相关性和正确性。技术人员应该修正文档管理并保证它的可读性与实用性。使技术文档人员成为团队的一部分,让他们在这一过程中充分合作而不只是在最后时把让东西转交给他们。

  5. 注意准确性与简洁性

  对于广泛文档管理(除去它将在会减慢项目并没有增值外)的一个大问题是,它通常伴有错误的发生。把注意力放在调试代码能力和资源上比放在调试文档管理上更有意义。这条技巧与第4条相辅相成。所以,要让技术人员了解,在整个项目过程中他们有一部分工作是协助他人把大部文档整理成简洁的形式。多数的细节提供通常只对用户文档很重要,因为这是你知道的内容,它们将访问和依赖于整个生命周期的最一个应用程序。

  6. 使用自文档化代码

  使用注释并不总是最好的替代。然而良好的编码习惯是一个很好的主意,可以明确到其目的和含义。当一段代码本身不能简单地被解释时,就要使用注释澄清代码。这种转变对于自文档化代码是非常符合敏捷的概念,因为它会在开发的过程中随着变化自然而然的演化。

  7. 使需求最小化

  项目的利益相关者有时更希望把一些文档格式写成需求文档,而不是简单的选择文档。在这一点还有改进的余地的,除非你能给你的客户展示出不同的方法给你的客户,即给客户他们真正想要的,而不是他们认为想要的东西。然而,当事态严重时,你的团队应该提供匹配客户最低要求的文档。如果你在第一个项目中给出一个最重要的结果,那么你的利益相关者在下一次的项目中就会放宽一些要求。

翻译

蒋红冰
蒋红冰

TechTarget云计算主编,主要负责云计算和虚拟化网站的内容建设。长期专注于IT前沿技术,对云计算、虚拟化、人工智能、区块链等技术都有了解;对行业趋势、市场动态有一定的洞察。

相关推荐