【软件工程】写文档真的很重要——文档总结

迈不过友情╰ 2022-08-10 14:51 411阅读 0赞

**   最近在360DOC上面看到了一篇文章，题目叫做[《比较中国与印度软件工程师》][Link 1]，主要从教育水平、职业素质等方面比较了中国与印度软件工程师，这才意识到为什么专业化的第一课是软件工程。文档的存在也正是印证了一句话：做事情做到没有头绪的时候就想到了管理。文档作为一种软件管理的工具，控制着整个开发流程；文档作为一种沟通交流的方式，把用户、开发人员、管理人员、测试人员联成了一个整体，是企业的核心竞争力啊。**

**   尽管文档是软件开发中重要的一环，但是常常也是容易被忽视的一个环节。软件工程师们不喜欢写文档，因为他们常常把自己定位成艺术家——创造，而不是一个工程师。就像是浪漫的诗人，不喜欢给自己有感而发的诗句配上注释；还有那些具有妙手的画家，不喜欢用文字来描述画面中的意境。但是，作为一名工程师，软件的制作并不是一个可以随意发挥的艺术工作，我们不需要朦胧之美而是清楚而科学的文字介绍。软件的灵魂并不是Code,只会不停的coding的程序员儿已经成为公认的坐在办公室的蓝领了。想做一名项目的管理者，必须是一名严谨的工程师。**

**   讲了这么关于“写文档真的很重要”的道理，下面是我有关文档的导图总结。**

**![SouthEast][]**

**    关于这个图的分类还有记录文档、投产文档、反馈文档。因为我们现在还没有写过，所以就没有画出来。图中有开发文档、管理文档、用户文档三类。**

**    1、开发文档：这类文档在软件项目开发过程中，体现了软件开发人员前一阶段工作的成果，同时又是后一阶段工作的依据。具有着里程碑的作用，同时也利于维护人员的维护工作。**

**    2、管理文档：这类文档在软件项目开发过程中，由软件开发人员制定的需提交管理部门的一些工作计划、工作方案和工作报告。通过阅读这些文档，管理人员能够了解软件项目开发活动安排、进度、资源使用等情况。**

**    3、用户文档：这类文档是软件开发人员为使用该软件的用户提供的有关本产品使用、操作的资料。**

**    站在巨人的肩膀上，我看到了很多师哥师姐们精彩的总结博客。向他们学习啦~**

*  [软件的生存周期各阶段及对应文档][Link 2]
 *  [软件工程 文档][Link 3]
 *  [软工文档 “旅行记”][Link 4]
 *  [图解软工文档][Link 5]

**   ** **小结：**

**    通过这次的软工之旅，感觉自己学习了不少计算机专业的知识，自己的基础不好（计算机常识缺乏），所以对于很多名词最基本的意思都是靠百度去理解。这些理论基础要我们慢慢的去积累，在以后实践中才能看到认真积累的好处。**

[Link 1]: http://www.360doc.com/content/12/0207/18/7213026_184839450.shtml
[SouthEast]: /images/20220810/e57e5e1e6f4644219dac02e4569bbfb4.png
[Link 2]: http://shan9liang.blog.163.com/blog/static/170509114201162592610306/?newRecomBlog
[Link 3]: http://blog.csdn.net/lishuangzhe7047/article/details/8119552
[Link 4]: http://blog.csdn.net/wangmei4968/article/details/20290447
[Link 5]: http://blog.csdn.net/u010191243/article/details/18819957