楼主:
jonjes (HONOKA)
2018-10-04 20:31:37最近写文件、架构或画流程图的机会变多了
虽然同事说只要找个专案外的第三者来看，对方能懂就好了
但还是很犹豫文件到底要定义到多细才好？
像func name 、func用途、参数、该参数的用途等
一般还会加个后续处理要做什么吗
（感觉这比较像是需求文件、而不是技术文件该加的）
作者:
atpx (秋雨的心情)
2018-10-04 20:51:00看给谁看的
作者:
enthos (影斯作业系统)
2018-10-04 20:56:00作者:
Argos (Big doge is watching u)
2018-10-04 23:17:00你可以参考一下各大开源套件的Doc
作者:
guest0710 (guest0710)
2018-10-04 23:38:00个人想法 先确定大项有写清楚 再写细节最讨厌重点跟细节混杂在一起 很长的文件XD
重点是文件出去后，写的人跟看的人还会不会沟通文件的目的是为了帮助沟通、了解、还是白纸黑字责任范围
作者:
feeya (24 August 升格为乡民)
2018-10-05 00:42:00文件直接写在注解
function 或 restful api 的话给外部用的要有文件说明用途，参数，注意事项会比较好。内部实作可能会一直更动，我是觉得不一定要文件，但命名之类的要顾好。
作者:
y3k (激流を制するは静水)
2018-10-05 22:59:00能帮助看的人快速补齐所需知识的文件 才是好文件要达到这个标准 首先要问自己 要写给谁看?prerequisite如何正所谓因材施教也
作者:
f124 (....)
2018-10-06 12:19:00老板看了觉得好的就是好
作者: uiop019 (uiop019) 2018-10-06 15:42:00
上网找找SAP ERP的系统文件，那样的内容就够了