软件工程中的文档

一个很大的项目库，如果没有文档而且代码没有注释的话，是一件很让人头痛的事，老大最近强调：所有的代码，必须代码走到哪儿，文档跟到哪儿!说真的，对于软件文档，真的一点概念也没有，搜集了一些资料，看看软件文档是什么东东，其实在大学时，软件工程有学过的，那个时候，貌似都翘课了！

软件文档或者源代码文档是指与软件系统及其软件工程过程有关联的文本实体。文档的类型包括软件需求文档，设计文档，测试文档，用户手册等。其中的需求文档，设计文档和测试文档一般是在软件开发过程中由开发者写的，而用户手册等非过程类文档是由专门的非技术类写作人员写就的。

早期的软件文档主要指的是用户手册，根据的定义，文档是用来对软件系统界面元素的设计、规划和实现过程的记录，以此来增强系统的可用性，更是软件工程师之间用作沟通交流的一种方式。

综上，我们可以将软件文档定义为：
1. 文档是一种对软件系统的书面描述；
2. 文档应当精确地描述软件系统；
3. 软件文档是软件工程师之间用作沟通交流的一种方式；
4. 文档的类型有很种，包括软件需求文档，设计文档，测试文档，用户手册等；
5. 文档的呈现方式有很种，可以是传统的书面文字形式或图表形式，也可是动态的网页形式