软件开发的过程中,这些文档你都用到了吗

发布网友发布时间：2022-04-29 18:07

共1个回答

热心网友时间：2023-01-20 13:16

以我几次接手别人工作的经验看，最有用的文档是：

使用手册。要了解软件，首先要会用。好的使用手册应该包含快速入门指南和详细的参考。最好是开发人员写得。

概念设计文档。比较大的软件往往有自己的核心概念模型。它是如何对现实工作进行抽象的？最重要的数据结构是什么？还有整体模块的划分，系统的层次等架构性的东西。

代码。有篇著名的文章Code as Design[1]指明了真正的详细设计是包含在代码中的。这里的Design其实是个名词，并不是说用写代码来做设计，而是说只有读代码才能看到真正的详细设计。除了工作代码，注释和单元测试代码对理解软件也很重要。注释最重要的是说明一些非常规的，不易理解的东西。单元测试对理解某个函数接口的用处特别有用。

最没用的文档是详细设计文档，基本上每个项目中的这种文档都过时了，即是配合变更管理系统，查看起来依然很困难。

需要哪些文档是一方面，另外每个文档应该包含什么内容也很重要，不过那是另一个问题了。