Re: [請益] 怎樣的文件才算好?

作者: wt (Time to Change!)   2018-10-04 21:39:18
可以從幾個角度去思考
1. 給誰看
工程師、PM、PR、業主。需要的資訊程度不同。
給同部門或者跨部門的工程師看,需要的資訊程度也不同。要考慮讀者背景差異。
2. 文件預計達成的目的為何
讀者可以從文件中找到或學會甚麼?
或是為了符合某些規定 CMMI
3. 文件更新頻率
文件內容最好不要跟實際落差太大。
太細或者有可能變更的資訊,就要考慮一下做法。
例如code level的資訊都用註解為主,再用工具把註解撈出來自動編成文件。
舉例來說:技術文件
對象:部門內後來加入的新人
目的:了解程式架構,方便新人快速上手。
對象:不同部門的工程師
目的:了解如何使用這套Lib/API
上面這個定位跟對象搞清楚,網路上就有很多文件範本可以參考。
※ 引述《jonjes (HONOKA)》之銘言:
: 最近寫文件、架構或畫流程圖的機會變多了
: 雖然同事說只要找個專案外的第三者來看,對方能懂就好了
: 但還是很猶豫文件到底要定義到多細才好?
: 像func name 、func用途、參數、該參數的用途等
: 一般還會加個後續處理要做什麼嗎
: (感覺這比較像是需求文件、而不是技術文件該加的)
作者: content71 (羅莉飼養中...)   2018-10-04 22:28:00
說的很好
作者: Ghamu (貓丸)   2018-10-05 00:06:00
最低標準 能讓未來的自己看懂
作者: viper9709 (阿達)   2018-10-05 00:14:00
推樓上
作者: TAKADO (朕沒給的你不能搶)   2018-10-05 23:56:00
推2樓
作者: meowyih (meowyih)   2018-10-06 12:35:00
據統計,九成以上的程式說明文件最後都只有自己會看XD

Links booklink

Contact Us: admin [ a t ] ucptt.com