开发人员应该在开始编码之前编写“解决方案文档”吗？

Question

我们这样做的原因是“编码前的计划”，而另一个要点是“帮助团队中的新成员”。我们是一个由5-8人组成的团队。我们的项目中包含了API文档和自述文件。编写一次解决方案文档并不是一项艰巨的任务。但是所面临的问题是，要将我们在源代码中的每一个后期更改都保持为单独的解决方案文档是很费时且困难的。所以写一个解决方案文档值得吗？

Answer 1

这取决于创建文档的原因。

1. 向客户展示所期望的内容，并作为项目的规范。
2. 作为新启动者可以参考的软件的指导手册。
3. 随着时间的推移跟踪软件的需求，这样新的请求就不会错误地删除很少使用的需求等等。

我想说的是，解决方案文档对于1非常好，但是人们已经停止了与2一起使用单元/验收测试3。

如果您发现您正在创建文档，因为“我们需要文档！”但没人读过。那就别再写了。