[請益] 怎樣的文件才算好？ 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的系統文件，那樣的內容就夠了

繼續閱讀