[请益] 怎样的文件才算好？ jonjes PTT批踢踢实业坊

楼主: jonjes (HONOKA) 2018-10-04 20:31:37

最近写文件、架构或画流程图的机会变多了
虽然同事说只要找个专案外的第三者来看，对方能懂就好了
但还是很犹豫文件到底要定义到多细才好？
像func name 、func用途、参数、该参数的用途等
一般还会加个后续处理要做什么吗
（感觉这比较像是需求文件、而不是技术文件该加的）

作者: cha122977 (CHA) 2018-10-04 20:41:00

看了可以更快了解程式码就算不差了

作者: atpx (秋雨的心情) 2018-10-04 20:51:00

看给谁看的

作者: enthos (影斯作业系统) 2018-10-04 20:56:00

作者: RunRun5566 (跑跑五六) 2018-10-04 22:09:00

细节不用写文件，写测试就好

作者: Argos (Big doge is watching u) 2018-10-04 23:17:00

你可以参考一下各大开源套件的Doc

作者: guest0710 (guest0710) 2018-10-04 23:38:00

个人想法先确定大项有写清楚再写细节最讨厌重点跟细节混杂在一起很长的文件XD

作者: landlord (91) 2018-10-04 23:59:00

重点是文件出去后，写的人跟看的人还会不会沟通文件的目的是为了帮助沟通、了解、还是白纸黑字责任范围

作者: Darkword1987 (黑字) 2018-10-05 00:26:00

有随时间update的文件

作者: feeya (24 August 升格为乡民) 2018-10-05 00:42:00

文件直接写在注解

作者: brianhsu (坟墓) 2018-10-05 07:49:00

function 或 restful api 的话给外部用的要有文件说明用途，参数，注意事项会比较好。内部实作可能会一直更动，我是觉得不一定要文件，但命名之类的要顾好。

作者: dreamnook (亚龙) 2018-10-05 13:23:00

input output 用途说明

作者: y3k (激流を制するは静水) 2018-10-05 22:59:00

能帮助看的人快速补齐所需知识的文件才是好文件要达到这个标准首先要问自己要写给谁看?prerequisite如何正所谓因材施教也

作者: lovebridget (= =") 2018-10-06 10:46:00

老板觉得好的那样才算好适用于任何情况任何问题

作者: f124 (....) 2018-10-06 12:19:00

老板看了觉得好的就是好

作者: uiop019 (uiop019) 2018-10-06 15:42:00

上网找找SAP ERP的系统文件，那样的内容就够了

继续阅读