iT邦幫忙

DAY 12
5

如何提升系統設計品質 - 技術與工具以.NET為例系列 第 12

[如何提升系統品質-Day12]命名-Glossary的建立

  • 分享至 

  • xImage
  •  

在開發系統的時候,您是否也有以下的困擾:
1.是否存在著同一個意思的term,卻有著多個名字
2.是否每次都不知道怎麼把腦袋中的命名翻譯成英文,用字典查卻有多個單字不知道該選哪一個
3.是否看到一堆縮寫的term,卻不知道意思是什麼
4.Developer與domain expert在溝通時雞同鴨講

今天這篇文章,要說明的是建立Glossary檔的好處。建立Glossary是一個花費成本很小,效益卻很高的系統開發程序,唯一的障礙就是成員的惰性。只要習慣了,發揮出來的效益相當高。

[如何提升系統品質]系列文章連結
目的
1.統一詞彙與對照
2.降低溝通障礙
3.專業分工
4.持續累積domain knowledge

分工方式
1.Developer:
遇到不確定的term,即到Glossary查詢對照英文,若不存在,則新增中文與說明

2.Domain expert:
收到developer的請求,則上去補足英文的term,以及相關範例說明

記錄欄位
1.中文
2.英文
3.說明
4.範例

建議工具

範例
使用Google Doc,建立『魔獸世界Glossary』。

注意事項
在設計系統時,應盡可能避免使用非英文語系的命名,因為你永遠不知道下次某個錯,會不會就是因為語系編碼造成的問題。

結論
開始試著建立自己系統的Glossary吧,你將會收到大吃一驚的效益。

資源網站
1.DropBox
2.EA
3.Google Doc,補充一下,Googole Doc有版控的功能,我的範例中使用的是Google新的功能:Table,目前還在beta,所以沒有版控。


上一篇
[如何提升系統品質-Day11]重構-使用介面+迴圈取代不穩定的判斷式
下一篇
[如何提升系統品質-Day13]品質量測工具- SourceMonitor簡介
系列文
如何提升系統設計品質 - 技術與工具以.NET為例30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

1 則留言

0
fillano
iT邦超人 1 級 ‧ 2011-10-21 14:00:47

記得幾年前有看過有人想用wiki模版來做出SQA的文件系統,不過不知道有沒有下文...XD

就是91 iT邦研究生 4 級 ‧ 2011-10-21 14:16:40 檢舉

習慣用mind map之類的工具後,就覺得wiki編輯好麻煩喔。

雖然都偷吃步,用mindmap轉wiki的格式,但是只是單向轉成wiki,享受不到反向編輯的好處。
要編輯的時候,就又是從wiki當出發點了。

我要留言

立即登入留言