Follow

最近在帶同事寫軟體開發的文件,順便整理分享出來。
❓文件一片空白,腦袋也一片空白,該如何開始呢?
1、首先是確認目標。看文件的人,總是有個目標必須達成,對他而言的目標是什麼?不同工作崗位的人目標通常都不同,因此文件也不會一樣。例如後端工程師的目標可能是產出API;而前端工程師可能是UI流程與介面控制。
2、為了達成這個目標,首先我必須取得什麼資料?這個資料從哪裡來?如果資料不齊全該怎麼辦…?
3、拿到資料之後,我需不需要做處理、如何處理?相關的演算法是什麼?
4、處理後的資料,我應該做那些事?把這些事拆成幾個步驟,一步一步解釋,步驟間不要跳躍。這些步驟有什麼要注意的細節,或是不同條件下的額外處理,一一列出。
5、如果上敘步驟不是單一條線,而有多線交會,就用流程圖匯集釐清,再個別寫清楚。流程不清楚時,可以用列舉case的方式釐清。
6、沒有完美的文件,如果有缺漏別人不清楚,再補就好了。

· · Web · 1 · 0 · 2

文件溝通的成本會比單純口頭描述還要高,但是有它的優勢。
1、需要溝通的對象較多時,比起一個一個講,整理一份文件不見得比較慢。
2、你講的不見得是我聽的。兩個人對話時聽錯、記錯都是有可能發生的,會產生額外的溝通成本,有時甚至會影響彼此的合作關係。這種潛在的風險必須注意。
3、程式交接時,需求文件可以直接變成交接文件。

Sign in to participate in the conversation
Liker Social

Decentralized microblogs based on LikeCoin & Mastodon and help you take back your own community.