统计帖,请问各位开发的老哥,公司会要求你们写文档吗?

2023-01-08 20:14:05 +08:00
 liuguangxuan

最近项目做完了,被公司要求写各种文档,动辄十几个文档,而且要求配各种图(组成图、架构图、流程图等等)。被整的头都大了。

有点儿好奇其它公司是什么样子的。所以想问一下各位老哥:

  1. 你们公司会要求开发写文档吗?
  2. 分别有哪些文档?
  3. 写文档占开发的时间比?
3032 次点击
所在节点    程序员
20 条回复
ysicing
2023-01-08 20:19:43 +08:00
需要写
看需求大小,大需求,写设计方案,数据库结构(DBA 评审),API 文档,测试用例
cydysm
2023-01-08 20:21:33 +08:00
我最讨厌两种人了
1 、不写文档的人
2 、让我写文档的人


要写文档
wu67
2023-01-08 20:55:12 +08:00
只有在上家接了国企的外包时才需要写.
另外如果给时间, 写也不是不行, 最烦的就压缩工期要你写文档, 写文档的时间不允许写进文档...
leyfung
2023-01-08 21:04:16 +08:00
概要设计、详细设计
815979670
2023-01-08 21:04:19 +08:00
我们开始只是要求写文档,后来我用多余的实际 在文档的基础上再加上流程图 让整个逻辑看起来更清晰
hhjswf
2023-01-08 21:28:37 +08:00
要啊,项目验收的时候客户会要文档
yolee599
2023-01-08 21:29:33 +08:00
让产品经理写,需求都是他出的他最清楚
gowk
2023-01-08 22:21:59 +08:00
想问下大家这样的文档你们团队一般保存在哪里?用什么工具
moonrailgun
2023-01-08 22:34:03 +08:00
产品经理要写,开发要写,QA 要写。
FranzKafka95
2023-01-08 23:10:31 +08:00
详细设计文档你总要写吧
hiugo
2023-01-09 06:40:53 +08:00
@gowk confluence
iovekkk
2023-01-09 09:08:52 +08:00
会,纳入了季度考核指标
而且还 TM 非常蛋疼的是先写代码后写文档
其实也就是为了流程补文档
不过好处就是可以瞎写,只要内容丰满即可
7911364440
2023-01-09 09:47:36 +08:00
接口文档+设计文档
zhanlanhuizhang
2023-01-09 09:47:38 +08:00
1 ,非常不喜欢先写代码,后补文档。(感觉对自己就是坑)
2 ,遇到业务复杂的中大型项目,不写文档,我已经体验过了。业务型 bug ,满天飞各个模块之间的调用好多问题。
yaphets666
2023-01-09 09:56:07 +08:00
写呗,反正按时间算钱,加班写就算了。
yc8332
2023-01-09 09:58:42 +08:00
不写。。就写接口文档。。做业务的谁写那个啊。。难道是给人外包做系统吗
wangerka
2023-01-09 14:25:21 +08:00
OP 和层里说的都是后端吧,前端很少要求写文档
exonuclease
2023-01-09 14:28:53 +08:00
有一堆 design doc troubleshooting guide 还有各种接口 or 工具的文档 好在活不多有空写
allgy
2023-01-09 16:45:43 +08:00
只写 API 文档,其他的一律免谈
gausszhou
2023-01-10 00:50:29 +08:00
可信变革...

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/907413

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX