作者jonjes (HONOKA)
看板Soft_Job
標題[請益] 怎樣的文件才算好？
時間Thu Oct 4 20:31:37 2018
最近寫文件、架構或畫流程圖的機會變多了
雖然同事說只要找個專案外的第三者來看，對方能懂就好了
但還是很猶豫文件到底要定義到多細才好？
像func name 、func用途、參數、該參數的用途等
一般還會加個後續處理要做什麼嗎
（感覺這比較像是需求文件、而不是技術文件該加的）
--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 111.185.154.161
※ 文章網址: https://webptt.com/m.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