跟踪(功能)设计文档的更改

时间:2009-03-24 16:16:53

标签: document

我正在寻找一种方法来使设计文档与最新决策保持同步。

我们是一个小团队(两位开发人员,游戏设计师,平面设计师,项目经理,销售人员)。我们的大多数项目持续了几个月。在项目开始时进行了设计,但我们通常发现自己在整个项目中进行了更改或新的决策。大多数这些变化都是改进,因此我们希望保持这样的流程。 (如果更改的设计导致需要更多时间,则通常需要处理,因此该部分可以正常使用)

然而,目前我们没有很好的方法来捕获初始设计文档的更改,这导致初始设计在编码时很快被放弃作为源。这当然是浪费精力。

目前我们的文档是OpenOffice / Word,跟踪这些文档中更改的最佳方法可能是在文档顶部添加更改列表并在文本中并行进行更改 - 这不是我真正的选项认为理想。

我看过需求管理软件,但这看起来很专业。这些文件可以存储在颠覆中,但我认为这有点太低了,无法洞察变化。

有没有人知道跟踪这些变化的好方法,并在整个项目中保持设计文档的宝贵资源?

编辑:目前我们主要依靠对原始设计的更改放在bugtracker中,这样他们至少某处

编辑:相关问题

5 个答案:

答案 0 :(得分:4)

如果用户数量相对较少,我发现修改日志记录的wiki可以作为Word文档的升级版。找到一个可以轻松快速编辑的内容有助于确保它保持最新。

答案 1 :(得分:1)

openoffice和word都包含用于显示/隐藏文档编辑的功能。假设有改变的阻力,那么这是你最好的选择 - 或者导出到文本并将其放入任何源控制软件。\

或者,为更改说明文本维护单独的(使用适当的工具可扩展)文档,并在适当的时间点保存存档版本。

答案 2 :(得分:1)

这个问题在我们的编程商店也是一个长期存在的问题。有趣的是,程序员倾向于从错误的优化角度来看待这个问题:“将所有东西放在一个地方”。在我看来,你有两个主要问题:

  • 更改的描述必须易于阅读(“那么新的内容是什么?”)
  • 该流程应优化,以便编写规范以达成一致,然后开始工作!

想象一下如何在另一个环境中解决这个问题:政府立法。每当政府增加另一项法律或改变一项法律时,法律手册都不会改写“轨道变更”......

最好的方法是永远不要触摸已发布的文档。不要把所有东西都塞进同一个文件中,你会得到:

  • 可怕的版本历史记录表
  • 永恒状态“草稿”
  • 分散的不一致,
  • 可怕的匆匆句子,
  • 肮脏的混合作者的风格

相反,发布一个附录,仅详细描述更改,并可能替换原始的完整段落/页面。

根据我们项目的规模,这可能永远不会有效,是吗?

在我迄今为止最大的项目中,我发布了一个基本规范和5个连续的附录。每页大约5页。 像魅力一样工作!

答案 3 :(得分:0)

我不知道任何好的,免费的配置管理工具,但为什么不将您的设计置于源代码管理之下?只需将其添加到SVN,CVS或您正在使用的任何内容。这很好,因为:

1)它始终是最新的(当然,如果你检查它)

2)集中

3)您可以使用几乎所有源控制系统中都提供的内置比较功能来跟踪更改

它可能不是你想要的“有进取心”的解决方案,但无论如何你都是一个小型的开发团队,所以对于这种情况,它不仅仅是完美的。

编辑:我现在看到你已经提到了一个源控制系统,我的错误。不过,我认为它应该运作良好。

答案 4 :(得分:0)

使用Google文档。它是免费的,基于Web的,多用户实时,您可以选择谁有权访问您的文档,并保持版本控制。您还可以上传所有word文档,它将为您转换它们。 有关详细信息:http://www.google.com/google-d-s/intl/en/tour2.html