这是一个创建于 1959 天前的主题，其中的信息可能已经有所发展或是发生改变。
一个新项目，在没有强制要求，验收要求的情况下，大家也会按软件开发方法先写各种文档吗？都写哪些文档？（外部系统访问的 API 接口文档除外）
 |
1
li27962278 2019-07-18 16:21:14 +08:00
现在项目要交接给另外的团队 自己负责的模块要写文档...
要求是 :1.页面功能总述 2.功能列表:列出页面的全部功能，每一个功能的作用是用做什么的。 3.初始化页面逻辑,调用关系:描述所做功能的前后端关系图，内外部调用关系，前后端数据接口，后端的层级关系，数据库表格，时序图等。时序图关键步骤描述，根据时序图节点进行说明，写出代码位置。 头大了... |
 |
2
leon0903 2019-07-18 16:23:33 +08:00
不写，最多搞一个 swagger 文档。
|
 |
3
theoran 2019-07-18 16:23:43 +08:00
理论上是先写文档后写代码
实际上是先写代码后补文档。。。 |
 |
4
bayker OP @li27962278 如果你是接别人团队的项目，估计你也会这么要求别人这样写文档吧，哈哈。
@leon0903 什么也不写的话后面怕出了什么疑问自己都得翻源码才行。 @theoran 实际上确实是这样。 |
|
6
li27962278 2019-07-18 16:43:16 +08:00
|
 |
7
Fule 2019-07-18 16:51:30 +08:00
程序员最恨两件事：
1. 写文档 2. 别人的东西没有文档 |
 |
9
gz911122 2019-07-18 17:24:46 +08:00
先写技术方案,因为要做技术评审.
然后写 api 文档 然后开搞 |
Select Language