[吐槽贴]领导对于要求文档的详细程度到了偏执的程度

[Vaspike]

• 矛盾

核心矛盾: 工资待遇很不错

写代码前要求我先把文档写出来,详实程度要求每个 service 中将会有哪些方法,共有私有

开会的时间占到了工作时间的 50%左右

领导是写代码出身,但每次开会和其他交流中都透露出对"写代码为低级工作,确定业务为高级工作"的看法

我不否认他的某些想法,目前也会尽力完成他想要的东西,只是怕很多矛盾后面会越来越尖锐 最近和其他同事一起下班才知道部门其他同事也对他颇有微词,我进来时替换的这个岗位原来的开发就是被骂跑的

[Tyrant1984]

还行吧，我这边 SB 公司，写个周报老板甚至会挑你标点符号用的不够“标准”，比如分段数字序号后面必须用顿号，分段结束后必须用分号之类的，标点符号不能让他满意他就让你重写。

[anzu]

业务驱动型项目是这样的。日企项目的文档才是详细到令人震惊，连方法内的代码也会在文档中以伪代码的形式描述出来。

[7lQM1uTy635LOmbu]

@Tyrant1984 #21 像极了我曾经做过的文档工程师

[huang86041]

和日企打过交道，很像日企的风格。

[NessajCN]

论 Rust 的优越性...
懂不懂 cargo doc 能省多少事啊....

[kneo]

私有方法是不可能在设计阶段就确定的。甚至公有接口也往往不能在设计阶段就能完全确定。在设计阶段纠结过多末枝细节是会降低生产力的。

当然，我有一个巧妙的方法，相信你也想到了。你先偷偷把代码写出来，然后作为设计提交上去。至于领导分配的写代码的时间，你可以去摸鱼，也可以提前去预测他下一阶段的设计。

[weofuh]

代码注释写详细点，再搞个工具，把注释提取出来就是文档了，哈哈哈哈。

"写代码为低级工作,确定业务为高级工作" 个人觉得这个没啥毛病吧，前提是能真的确定好

[encro]

先设计再编码！

这是锻炼从小工到大师的第一步，大师首先要做到的是胸有成竹，所谓心道手到，先心到然后做到手到，然后大师成。


我就是这么训练自己和 chatgpt 的。
先自己写伪代码，注释，然后将写代码变为填空。
当我发现自己设计出错了，那么往往就又学到了。

[k9990009]

给时间就行。研究下那种类似 yapi 接口文档生成工具，将代码注释提取生成文档

[SoyaDokio]

感觉是个很好的锻炼机会。
业务万变不离其宗写来写去就那么些，唯有业务五花八门，理解稍有偏差就可能导致成果物相去甚远。

另外文档这个东西是非常重要的，代码写多了可能就渐渐理解了。

[Tink]

这些东西可以交给 gpt 来做

[kamilic]

其实挺好的，设计到位了，其实怎么实现都是差不多的样子

[silencil]

大部分业务没有做设计的必要吧？很多接口，脑子里一过就知道是怎么回事，留个文档就是方便后续的人维护，但是文档很容易跟不上代码变更，初始的文档很可能又废了。

[yangzzzzzz]

写呗 反正算工时就行

[F7TsdQL45E0jmoiG]

这详实程度确实不够高

[NICEghost]

低级程序员，隐忍

[ZnductR0MjHvjRQ3]

工资待遇很不错就够了，毕竟他这个问题又不是什么十恶不赦的问题，只是有点吃屎，而且你为啥非要按照他的流程走，不能自己先写一部分然后用 AI 搞定文档自己再删删改改吗，我倒是认为你们老板的想法没啥大问题，确定业务就是很重要，毕竟你再花里胡哨的业务，只要是正常的基本都有人实现过了，代码层面都有可参考的东西，毕竟码农就是...

[Huelse]

你领导没错，代码只是低级工作，你甚至可以交给刚毕业的大学生写，但实现设计并不是谁都能做好。

等你写代码的时候更多考虑的是语法和语言特性，不会有太多思考逻辑的时间，这也是为什么要在开会和写文档的时候多思考，想好了再动手。

[mark2025]

抽象接口，方法用 swagger 加上输入输出备注，然后生成网页或者文档不行么？

[ShuWei]

既然钱给够了，你还有啥好抱怨的，如果你是给工资的人，你可以决定工作方式，否则做好执行