软工文档总结

￡神魔★判官ぃ 2022-06-05 06:41 233阅读 0赞

最近的一个月内，我把软工文档写完了，里面有很多都不知道怎么写，给我最大的感受就是：需要我填充的内容感觉都好像一样，这里写过了，到后面有些让我理解还是写的一样，结果我不知道怎么写、也懒的写了。后来找师父给我看文档，我写的都不知道是什么，我自己都搞不清楚，怎么能让别人看懂，对啊，为什么写文档，最重要的一个环节就是给别人看而且一看就懂你想表达什么。  
  
  师父给了我一个非常好的订餐的系统文档，看了学习了之后，更加的自愧不如，人家写的那文档简直好极了，我都不能用更好的言语去表达了。写的完完全全可以让处在我这水平的人看的明白，也知道想表达的什么，条理和逻辑非常清晰，看了内容，才知道原来文档是这么写的。  
  
  该有字的地方表达的很清晰，不该有文字叙述的地方不带有一个字的解释，只有图，而且也不会让你产生混淆的地方。看了这样的文档，我觉得我如果是一个公司的老总，我可以很放心的买你的系统。

![这里写图片描述][SouthEast]

**我对文档编写目的认识：**

**1、可行性研究报告：**  
  从各方面进行综合分析考虑，帮助项目负责人决策是否一个项目可以进行实施。读者：项目负责人。

**2、项目开发计划：**  
  列出详细的各阶段开发计划、目标以及里程碑；是跨项目开发周期的，需要进行不断的更改。读者：项目负责人、客户。（其实整个有关项目的人员都可以看）

**3、软件需求说明书：**  
  根据用户的需求进行分析而编写的，其实也可叫功能说明书，是与用户之间交流沟通的最重要的文档，它用来描述用户需要那些功能，以及如何使用这些功能，而不考虑功能如何实现。读者：用户、设计人员、开发人员、测试人员。

**4、概要设计说明书：**  
  本文档要描述或说明清楚系统的结构以及结构或模块之间的联系、各个模块的功能、接口信息、出错信息等等。读者：设计人员、开发人员、测试人员。

**5、详细设计说明书：**  
  它是更加注重于底层的、具体的实现，如果概要设计描述的是宏观，那么详细设计就是描述的是微观，二者相辅相成，缺一不可。它具体描述的是如何实现模块之间的联系，说明数据的结构、存储结构、逻辑结构以及函数之间的调用实现等等。读者：设计人员、开发人员、测试人员。

**6.1、数据库设计说明书：**  
  描述数据库中的数据结构以及数据存储，还有表的结构、内容以及约束情况信息。读者：设计人员、测试人员。

**6.2、数据要求说明书：**  
  此文档是更加具体描述数据之间的联系、传递、流向等，描述了系统使用的所有的数据信息，包括用户对使用数据的规定和要求。读者：设计人员、开发人员、测试人员。

**7、测试计划：**  
  系统大致完成后，需要进行测试以便完善和改进；为此对整个系统制定严谨、科学的测试方案，对系统的功能正确性和要达到的目标给出明确规定。读者：测试人员。

**8、测试分析报告：**  
  经测试后，将测试的结果记录下来，给出分析以及不合格的理由；给开发人员提供帮助，进而完善系统。读者：设计人员、开发人员。

**9、项目开发总结报告：**  
  当项目完成后，总结出在这次项目中遇到的问题和困难以及经验和教训，为以后开发项目积累经验，提高工作效率。读者：所有参与项目的人员。

**10、操作手册：**  
  给用户看使用，主要用途是帮助用户找到功能的具体操作步骤。读者：用户。

**11、用户手册：**  
  用户使用，提供关于产品介绍信息、以及保修期、出版公司、与公司的联系方式等等。读者：用户。

**12、开发进度月报：**  
  是跨整个项目周期的文档，它记录了开发过程中的时间、状态；它的重要性体现在及时发现问题、解决问题，当项目进度慢时，就要找出原因进行分析。读者：项目负责人。

**感受：**  
  我明白了一个道理，当你还找不到它们之间的区别时，说明还没有足够了解每个文档写的目的和它的作用。

![这里写图片描述][SouthEast 1]

总之，自己这方面真的差太多了，在学文档的时候，我是抱着这样的一个心态：写文档还不简单么，这有什么可写的。可能自己有点太骄傲了，对文档的这种看法让自己眼高手低；想起了老师教导的一句话：以零的姿态去学习。是啊，面对所有的学习，抱以一个归零的心态很重要，这让自己觉得这不会很正常，而且还会很开心，也不会让自己变得骄傲自大。  
  
  想起来我们的教育理念：授之以欲、授之以愉、授之以渔。真的非常有哲理，我都想在写一篇博客来说说自己的感受了，这篇博客主要还是讲我的文档学习，我没做到“授之以愉”，当然不是说其它两点我做到了，只是相比之下、这种情况，第二点显得尤为重要，因为我的眼高手低，导致我学习时发现它有点难、不太好写，从而每次写的时候我很不开心，对文档充满了厌烦，想想一旦产生了对学习的厌烦，那就完蛋了。  
  
  对这次学习的认真思考和反思后，我一定会找到学习中的乐趣，让自己学习变得快乐。“授之以欲、授之以愉、授之以渔”，看着简单嘛？千万不要用这种角度看，这么做只会眼高手低、限制你的思维，还是那句话以归零的心态去再看这三点，会体会到非同一般的感想。

[SouthEast]: /images/20220605/2f60723b70c14383b492b71bb64a102c.png
[SouthEast 1]: /images/20220605/b640f4bafc0840f2b503c91e55bd721c.png