PTT職涯區 / Soft_Job (軟體人)

[請益] 怎樣的文件才算好？

看板Soft_Job (軟體人)作者 (HONOKA)時間7年前 (2018/10/04 20:31), 編輯推噓8(8推 0噓 14→)
留言22則, 15人參與, 7年前最新討論串1/2 (看更多)
最近寫文件、架構或畫流程圖的機會變多了 雖然同事說只要找個專案外的第三者來看，對方能懂就好了 但還是很猶豫文件到底要定義到多細才好？ 像func name 、func用途、參數、該參數的用途等 一般還會加個後續處理要做什麼嗎 （感覺這比較像是需求文件、而不是技術文件該加的） -- ※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 111.185.154.161 ※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1538656299.A.0BB.html
→
10/04 20:41, 7年前 , 1F
看了可以更快了解程式碼就算不差了
10/04 20:41, 1F
→
10/04 20:51, 7年前 , 2F
看給誰看的
10/04 20:51, 2F
推
10/04 20:56, 7年前 , 3F
10/04 20:56, 3F
推
10/04 22:09, 7年前 , 4F
細節不用寫文件，寫測試就好
10/04 22:09, 4F
推
10/04 23:17, 7年前 , 5F
你可以參考一下各大開源套件的Doc
10/04 23:17, 5F
推
10/04 23:38, 7年前 , 6F
個人想法 先確定大項有寫清楚 再寫細節
10/04 23:38, 6F
→
10/04 23:39, 7年前 , 7F
最討厭重點跟細節混雜在一起 很長的文件XD
10/04 23:39, 7F
→
10/04 23:59, 7年前 , 8F
重點是文件出去後，寫的人跟看的人還會不會溝通
10/04 23:59, 8F
→
10/04 23:59, 7年前 , 9F
文件的目的是為了幫助溝通、了解、還是白紙黑字責任範圍
10/04 23:59, 9F
→
10/05 00:26, 7年前 , 10F
有隨時間update的文件
10/05 00:26, 10F
→
10/05 00:42, 7年前 , 11F
文件直接寫在註解
10/05 00:42, 11F
推
10/05 07:49, 7年前 , 12F
function 或 restful api 的話給外部用的要有文件說明用
10/05 07:49, 12F
→
10/05 07:49, 7年前 , 13F
途，參數，注意事項會比較好。內部實作可能會一直更動，
10/05 07:49, 13F
→
10/05 07:49, 7年前 , 14F
我是覺得不一定要文件，但命名之類的要顧好。
10/05 07:49, 14F
→
10/05 13:23, 7年前 , 15F
input output 用途說明
10/05 13:23, 15F
→
10/05 22:59, 7年前 , 16F
能幫助看的人快速補齊所需知識的文件 才是好文件
10/05 22:59, 16F
→
10/05 23:01, 7年前 , 17F
要達到這個標準 首先要問自己 要寫給誰看?prerequisite如何
10/05 23:01, 17F
→
10/05 23:03, 7年前 , 18F
正所謂因材施教也
10/05 23:03, 18F
推
10/06 10:46, 7年前 , 19F
老闆覺得好的那樣 才算好
10/06 10:46, 19F
→
10/06 10:46, 7年前 , 20F
適用於任何情況 任何問題
10/06 10:46, 20F
推
10/06 12:19, 7年前 , 21F
老闆看了覺得好的就是好
10/06 12:19, 21F
推
10/06 15:42, 7年前 , 22F
上網找找SAP ERP的系統文件，那樣的內容就夠了
10/06 15:42, 22F
‣ 更多 jonjes 的文章
文章代碼(AID): #1RjWWh2x (Soft_Job)
討論串 (同標題文章)
以下文章回應了本文：
完整討論串 (本文為第 1 之 2 篇)：
排序： 最新先 | 最舊先 | 留言數
在新視窗開啟完整討論串 (共2篇)
Soft_Job 近期熱門文章
更多 近期熱門文章 >>
PTT職涯區 即時熱門文章
更多 即時熱門文章 >>
‣ 更多 jonjes 的文章
文章代碼(AID): #1RjWWh2x (Soft_Job)