问下，大家做项目都是先写文档吗？写哪些文档？

[bayker]

一个新项目，在没有强制要求，验收要求的情况下，大家也会按软件开发方法先写各种文档吗？都写哪些文档？（外部系统访问的 API 接口文档除外）

[li27962278]

现在项目要交接给另外的团队 自己负责的模块要写文档...

要求是 :1.页面功能总述
2.功能列表:列出页面的全部功能，每一个功能的作用是用做什么的。
3.初始化页面逻辑,调用关系:描述所做功能的前后端关系图，内外部调用关系，前后端数据接口，后端的层级关系，数据库表格，时序图等。时序图关键步骤描述，根据时序图节点进行说明，写出代码位置。

头大了...

[leon0903]

不写，最多搞一个 swagger 文档。

[theoran]

理论上是先写文档后写代码
实际上是先写代码后补文档。。。

[bayker]

@li27962278 如果你是接别人团队的项目，估计你也会这么要求别人这样写文档吧，哈哈。
@leon0903 什么也不写的话后面怕出了什么疑问自己都得翻源码才行。
@theoran 实际上确实是这样。

[leon0903]

@bayker 代码写注释啊，关键性的代码写好注释就可以了。

[li27962278]

@bayker

我最多也就是代码写注释,文档确实是后面要求才写,不说的话自己不会主动写的 ;

个人习惯在部署一个子系统或模块的时候会写一些流程给自己看

[Fule]

程序员最恨两件事：
1. 写文档
2. 别人的东西没有文档

[bayker]

@Fule 所以很矛盾，纠结啊

[gz911122]

先写技术方案,因为要做技术评审.
然后写 api 文档
然后开搞