命名-Glossary的建立
前言
在開發系統的時候,您是否也有以下的困擾:
- 是否存在著同一個意思的term,卻有著多個名字
- 是否每次都不知道怎麼把腦袋中的命名翻譯成英文,用字典查卻有多個單字不知道該選哪一個
- 是否看到一堆縮寫的term,卻不知道意思是什麼
- Developer與domain expert在溝通時雞同鴨講
今天這篇文章,要說明的是建立Glossary檔的好處。建立Glossary是一個花費成本很小,效益卻很高的系統開發程序,唯一的障礙就是成員的惰性。只要習慣了,發揮出來的效益相當高。
目的
- 統一詞彙與對照
- 降低溝通障礙
- 專業分工
- 持續累積domain knowledge
分工方式
-
Developer
- 遇到不確定的term,即到Glossary查詢對照英文,若不存在,則新增中文與說明
-
Domain expert
- 收到developer的請求,則上去補足英文的term,以及相關範例說明
記錄欄位
- 中文
- 英文
- 說明
- 範例
建議工具
範例
使用Google Doc,建立『魔獸世界Glossary』。
注意事項
在設計系統時,應盡可能避免使用非英文語系的命名,因為你永遠不知道下次某個錯,會不會就是因為語系編碼造成的問題。
結論
開始試著建立自己系統的Glossary吧,你將會收到大吃一驚的效益。
Reference
1.DropBox
2.EA
3.Google Doc,補充一下,Googole Doc有版控的功能,我的範例中使用的是Google新的功能:Table,目前還在beta,所以沒有版控。
blog 與課程更新內容,請前往新站位置:http://tdd.best/