这是一个创建于 666 天前的主题，其中的信息可能已经有所发展或是发生改变。
最近项目做完了，被公司要求写各种文档，动辄十几个文档，而且要求配各种图（组成图、架构图、流程图等等）。被整的头都大了。
有点儿好奇其它公司是什么样子的。所以想问一下各位老哥：
- 你们公司会要求开发写文档吗？
- 分别有哪些文档？
- 写文档占开发的时间比？
 |
1
ysicing 2023-01-08 20:19:43 +08:00
需要写
看需求大小，大需求，写设计方案，数据库结构(DBA 评审)，API 文档，测试用例 |
 |
2
cydysm 2023-01-08 20:21:33 +08:00 via iPhone
我最讨厌两种人了
1 、不写文档的人 2 、让我写文档的人 要写文档 |
 |
3
wu67 2023-01-08 20:55:12 +08:00
只有在上家接了国企的外包时才需要写.
另外如果给时间, 写也不是不行, 最烦的就压缩工期要你写文档, 写文档的时间不允许写进文档... |
 |
4
leyfung 2023-01-08 21:04:16 +08:00
概要设计、详细设计
|
 |
5
815979670 2023-01-08 21:04:19 +08:00
我们开始只是要求写文档，后来我用多余的实际 在文档的基础上再加上流程图 让整个逻辑看起来更清晰
|
 |
6
hhjswf 2023-01-08 21:28:37 +08:00 via Android
要啊，项目验收的时候客户会要文档
|
 |
7
yolee599 2023-01-08 21:29:33 +08:00 via Android
让产品经理写，需求都是他出的他最清楚
|
 |
8
gowk 2023-01-08 22:21:59 +08:00
想问下大家这样的文档你们团队一般保存在哪里？用什么工具
|
 |
9
moonrailgun 2023-01-08 22:34:03 +08:00
产品经理要写，开发要写，QA 要写。
|
 |
10
FranzKafka95 2023-01-08 23:10:31 +08:00 via Android
详细设计文档你总要写吧
|
 |
12
iovekkk 2023-01-09 09:08:52 +08:00
会，纳入了季度考核指标
而且还 TM 非常蛋疼的是先写代码后写文档 其实也就是为了流程补文档 不过好处就是可以瞎写，只要内容丰满即可 |
 |
13
7911364440 2023-01-09 09:47:36 +08:00
接口文档+设计文档
|
 |
14
zhanlanhuizhang 2023-01-09 09:47:38 +08:00
1 ，非常不喜欢先写代码，后补文档。（感觉对自己就是坑）
2 ，遇到业务复杂的中大型项目，不写文档，我已经体验过了。业务型 bug ，满天飞各个模块之间的调用好多问题。 |
 |
15
yaphets666 2023-01-09 09:56:07 +08:00
写呗，反正按时间算钱，加班写就算了。
|
 |
16
yc8332 2023-01-09 09:58:42 +08:00
不写。。就写接口文档。。做业务的谁写那个啊。。难道是给人外包做系统吗
|
 |
17
wangerka 2023-01-09 14:25:21 +08:00
OP 和层里说的都是后端吧，前端很少要求写文档
|
 |
18
exonuclease 2023-01-09 14:28:53 +08:00
有一堆 design doc troubleshooting guide 还有各种接口 or 工具的文档 好在活不多有空写
|
 |
19
allgy 2023-01-09 16:45:43 +08:00
只写 API 文档，其他的一律免谈
|
 |
20
gausszhou 2023-01-10 00:50:29 +08:00
可信变革...
|
Select Language