《如何写好项目文档》学习总结

代码、 文档、 项目管理是软件工程师的基本能力。其中项目文档分为需求文档、总设文档、详设文档（核心算法详细讲）和用户文档。（需求文档需要包括取舍的过程。）

文档包括封面（包括编号、项目、版本号）、修改记录（时间、人物、修改内容）、目录、正文、引用几个部分。正文可采取提纲式写法，自上而下写。

写文档的能力核心是分析问题、设计系统的能力。提高这两个方面的能力可提升写文档的能力。推荐材料如下：《金字塔原理》、《软件开发的201原则》中需求/设计的相关章节、Google关于系统设计的3大论文（GFS BigTable MapReduce）及各种经典和优秀的人文书籍。

 

【我的收获】在该课题学习中，印象最深刻或最有感触的内容是？为什么？

1，个人了解写文档的重要性，但是经常想明白或者在纸上画明白之后，就认为方案已经OK了，执行的过程中才发现有问题。

写文档是一个更严谨的理清思路的过程，帮助自己更全面的思考，所谓在方案上花的精力越大，项目整体耗时反而会越少。静下心，莫着急。

 

【学以致用】最想优先在工作中落地的方法是？准备怎么落地？

1，周报可以认为是一个文档，用于总结、分析日常工作。

2，小方向的改进（如监控方案、测试效率提高方案）等需要写好文档，严谨地理清思路。

3，图

3.1 软件工程领域有很多中图，架构图、流程图、时序图，个人对此有些理解，但是有些模糊，需要进一步明确其界限。架构图即是架构图，四不像有点丢人哦。

3.2 一个图片仅表达一件事情。

4，项目文档中需包含每次改动的大致介绍.

 

【我的困惑】写出你目前学习产生的问题

1，经常认为事情很简单，匆匆着手，结果对事情的复杂性缺少清晰的认识，导致项目延期。