作者jonjes (HONOKA)
看板Soft_Job
标题[请益] 怎样的文件才算好？
时间Thu Oct 4 20:31:37 2018
最近写文件、架构或画流程图的机会变多了
虽然同事说只要找个专案外的第三者来看，对方能懂就好了
但还是很犹豫文件到底要定义到多细才好？
像func name 、func用途、参数、该参数的用途等
一般还会加个後续处理要做什麽吗
（感觉这比较像是需求文件、而不是技术文件该加的）
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 111.185.154.161
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1538656299.A.0BB.html
1F：→ cha122977: 看了可以更快了解程式码就算不差了 10/04 20:41
2F：→ atpx: 看给谁看的 10/04 20:51
4F：推 RunRun5566: 细节不用写文件，写测试就好 10/04 22:09
5F：推 Argos: 你可以参考一下各大开源套件的Doc 10/04 23:17
6F：推 guest0710: 个人想法 先确定大项有写清楚 再写细节 10/04 23:38
7F：→ guest0710: 最讨厌重点跟细节混杂在一起 很长的文件XD 10/04 23:39
8F：→ landlord: 重点是文件出去後，写的人跟看的人还会不会沟通 10/04 23:59
9F：→ landlord: 文件的目的是为了帮助沟通、了解、还是白纸黑字责任范围 10/04 23:59
10F：→ Darkword1987: 有随时间update的文件 10/05 00:26
11F：→ feeya: 文件直接写在注解 10/05 00:42
12F：推 brianhsu: function 或 restful api 的话给外部用的要有文件说明用 10/05 07:49
13F：→ brianhsu: 途，参数，注意事项会比较好。内部实作可能会一直更动， 10/05 07:49
14F：→ brianhsu: 我是觉得不一定要文件，但命名之类的要顾好。 10/05 07:49
15F：→ dreamnook: input output 用途说明 10/05 13:23
16F：→ y3k: 能帮助看的人快速补齐所需知识的文件 才是好文件 10/05 22:59
17F：→ y3k: 要达到这个标准 首先要问自己 要写给谁看?prerequisite如何 10/05 23:01
18F：→ y3k: 正所谓因材施教也 10/05 23:03
19F：推 lovebridget: 老板觉得好的那样 才算好 10/06 10:46
20F：→ lovebridget: 适用於任何情况 任何问题 10/06 10:46
21F：推 f124: 老板看了觉得好的就是好 10/06 12:19
22F：推 uiop019: 上网找找SAP ERP的系统文件，那样的内容就够了 10/06 15:42