【软工】软工文档总结_软工文档提高班

【前言】

软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导，帮助，解惑的作用，尤其在维护工作中，文档是不可或缺的资料

【了解文档】

刚刚看到文档样本的时候参考的是GB8567——88，看的时候不知道该写些什么，后来经过了解知道了各个文档是做什么用的，可以软件文档初识，通过对各个文档的了解，结合之前学习的机房收费系统对文档进行了编写。

【文档作用】

看这么多的文档有什么用呢？开始的时候没有很想明白这件事情，就是觉得这就像是一份计划书，提前对这个项目的开发做好准备就好了，分工明确，对于项目的实施更加的可实施。在网上找了相关的资料，不管从哪个发展方向上说，培养自己的写文档能力是非常的重要。 如果你将来的发展方向是实施、项目管理，那么在项目过程中，不管在哪一家公司里，势必有大量的文档要写：总结、汇报、需求报告…，一个优秀的项目人员必须具备十分优秀的笔头功夫。特别是项目经理，这是基本功。 如果你将来的发展方向是开发、设计、系统分析师、架构师，那么，系统分析、设计报告也是必不可少的。一个优秀的、高级的设计、分析人员其文笔也是很漂亮的。 如果你将来向管理岗位发展，更不用说了，各类的规划、总结、述职报告等，也是需要很过硬的文字功底。（问了前辈，这是这样说的）

【怎样写好文档？】

1.改变文档为辅的观念，在平常的工作中，对于自己编写的每一份文档，均认真对待。
2.对于邮件的编写，要把自己想说的话准确地表达出来，在发送邮件之前，再看一下内容是否完整、是否还有错别字、语句是否通顺等。
3.在编写文档的过程中，要严格参照项目组规定的模板来完成。在写完文档之后，对文档进行语法检查，以纠正错别字和有语法错误的地方。一般说来，有语法错误的语句下面会有一条绿色的波浪线。在提交文档之前，再通读一下整个文档，看是否还有疏漏和不足。
4.在工作之余，可以读一些能够提高语言表达能力和写作能力的书籍或文章，看一下别人是怎样清晰地阐述自己思想的。例如，经常阅读CSDN上面优秀博主的博文就是一个提高自己写作能力的好办法。
——摘自【畅言】程序员既要写好代码，又要写好文档

【感受】
在写文档的过程中学习了做项目之前，不是头脑一热就开始开发了，而是有这明确的分工，文档对于团队的协作有着重要的作用，项目开发过程是否流畅，等等，可见写好文档是多么的重要了。