怎么说呢，最近这段时间感觉自己效率挺低的，也不知道是怎么回事。可能是项目快做完了吧哈哈哈哈哈，bug都改的差不多了，加上导师那边事情也比较多，所以我偷摸划水了快两个星期吧。另外感觉身体也有点问题，其实这周我睡得已经够早了，但是早上一直犯困，唉，也不知道怎么回事。希望接下来能调整回来吧。
这次想写点什么呢，其实主要想总结一下文档如何写。虽然公司给的有各个文档的模板，但是更应该从公司给的文档里面学到一些东西，而不是说离开了这些模板，我就不会写文档了。离开了这家公司我就不会写文档了。
一个好的项目需要包含详细的需求文档、设计文档、测试文档、安装手册以及运行手册，这些应该是一个项目最基本也是最重要的文档。其他文档应该是在这些基础之上延伸开来的。好了接下来就详细说一说这些文档具体应该包含哪些东西，也就是这些文档里面都应该写什么：

• 需求文档

  • 需求文档要明确指出产品预期达到的目标、本产品的各种角色及其职责，以及描述系统有哪些假定及约束信息，比如开发语言，数据库，系统预计上线时间等等。
  • 需求文档最重要的应该就是功能需求了。功能需求应该包括总体描述：功能清单和用例图，以及功能模块的详细描述
  • 数据需求、质量属性、外部接口需求、其他需求等有需求的话也需要写。

• 设计文档

  • 详细设计文档分为两种（研发类和维护类）
  • 维护类的详细设计文档，主要就写模块改造点
  • 研发类的详细设计文档需要写的地方比较多，包括子系统逻辑结构、模块实现设计、数据库设计以及界面设计
  • 子系统逻辑结构包括模块功能和模块组成
  • 模块实现设计包括各个模块的程序设计，其中主要分为描述、功能、输入项、输出项、接口、算法、读写表说明、程序实现流程，运行限制
  • 数据库设计包括数据访问额度和流量、数据库选型、异构数据库的连接与数据传递方式、数据共享方式设计、数据安全性及保密设计以及数据字典设计

• 测试文档

  • 测试文档的内容应该与详细设计文档中提到的模块相关，设计了什么功能就测试什么功能

• 安装手册

  • 将软件包下载下来之后所有流程一步一步记录下来，教阅读文档的人傻瓜式安装

• 运行手册

  • 与安装手册写的方法一致。

另外更新一下文档编写的几个注意事项：

1.结构不明显：大标题加粗
2.句式结构不统一：完成了XXX的开发，XXX的学习，XXX的了解
3.极端化的表达：避免出现极其，极大等词汇
4.段落中心不明确：一个自然段说好几个内容，不知道要表达啥，建议：结论放在最前面，后面分述，例如“试用期期间我各方面的素质获得了全面的提高，一是业务知识的丰富。。。二是技术能力的提升。。。三是开发流程的规范。。。。”
5.有些内容对表达中心思想没什么用的，可以删除，突出重点，不用事无巨细
6.混用口语表述和正式表述

底线：千万不能有错别字