Re: 這樣的方式我應該如何選擇--文件與經驗傳承
※ 引述《NDark (溺於黑暗)》之銘言：
: ※ 引述《ggg12345 (ggg)》之銘言：
: 1. 工程人都不喜歡寫文件。這是真的，喜歡寫文件能寫文件的可能就不會走這條路。
: 2. 文件是為了承先啟後，如果我們想一輩子做底層的程式設計師，當然功能做好等下班
: 就好。
: 3. 文件寫到夠用，看得懂就好。使用一些共同編輯的工具減少文件的維護問題（譬如說
: 註解或wiki）。
: 4. 不要硬逼工程人員達到不可能的標準，反而要逐步教育，一次只要求多一點，反彈就
: 會比較小。
: 5. 從源頭開始，從程式碼註解開始，寫程式碼的人最熟程式碼，讓他們在習慣的地方寫
: 文件。
: 6. 使用自動化的軟體建立文件，教育程式人員寫Doxygen的註解，減少撰寫無謂的文件
: 的時間（類別，成員，定義等等）。
: 7. 從進程式碼（commit）的註記開始，確保每次的改動都知道為了什麼。也就是有些人
: 提倡寫User Story，一口氣沒辦法從無到有把完整的文件建出來，那就從每次改程式
: 發生了什麼事情開始，一次只寫一點，累積這些軌跡，一樣有他的效果。
: 8. 先寫文件，再開發。讓程式人員在還沒真正寫程式之前把規格，問題，以及要做的事
: 情都搞清楚。避免過度設計或做多餘的介面與功能。
: 9. 開發後，寫文件。補充介面的註解，為什麼要寫這個功能，撰寫Tutorial或Example
: 。讓其他人知道到底這個功能：為什麼，是什麼，該怎麼用。
: 10.找助理來幫忙寫註解／文件，讓程式人員沒有藉口。
: 11.文件是為了溝通，用嘴巴講都很簡單，用嘴巴講都說就是這樣沒錯，一寫下來清清楚
: 楚白紙黑字賴不掉，馬上就改口說其實我的意思不是這樣。
: 12.文件從寫完的那一刻開始就過時了，但是一個過時的文件都比沒有文件來的好。
我認為寫文件要看是甚麼文件
像我比較討厭那種就只是給人看爽的文件
寫那種東西沒啥意思
如果是對之後的開發有用的文件
我會比較有興趣
至於要程式設計師寫程式碼的註解...
會有一個問題
就是程式設計師要不要花時間讓別人好接手
找助理幫忙寫註解或文件...這或許是個好主意
不過這當中通常都會有另一個問題...
"公司捨不捨得出錢請助理來做這些"
比較常見的結果就是...讓PG全包了
其實很多問題都是可以解決的
但是通常...人們為了不想付出時間或金錢
使得問題沒有被解決掉....
--
※ 發信站: 批踢踢實業坊(ptt.cc)
◆ From: 114.44.17.79
→
04/05 23:09, , 1F
04/05 23:09, 1F
推
04/05 23:50, , 2F
04/05 23:50, 2F
→
04/05 23:51, , 3F
04/05 23:51, 3F
推
04/05 23:55, , 4F
04/05 23:55, 4F
推
04/05 23:56, , 5F
04/05 23:56, 5F
→
04/05 23:58, , 6F
04/05 23:58, 6F
→
04/05 23:59, , 7F
04/05 23:59, 7F
→
04/06 00:01, , 8F
04/06 00:01, 8F
推
04/06 00:02, , 9F
04/06 00:02, 9F
推
04/06 00:04, , 10F
04/06 00:04, 10F
推
04/06 01:44, , 11F
04/06 01:44, 11F
→
04/06 08:14, , 12F
04/06 08:14, 12F
→
04/06 08:15, , 13F
04/06 08:15, 13F
討論串 (同標題文章)
本文引述了以下文章的的內容：
完整討論串 (本文為第 3 之 6 篇)：