推薦這個blog:

Award


(ASP.NET 2010、2011、2012年)

其他資源

簡體中文blog

最新回應

命名-Glossary的建立

前言
在開發系統的時候,您是否也有以下的困擾:

  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吧,你將會收到大吃一驚的效益。

Reference

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

 

 


點部落-In Joey

↑ Grab this Headline Animator


關連文章

[測試]單元測試的意義

[Tool]靜態程式碼分析-FxCop

[軟體工程]版本控管的重要概念

[Tool]Visual Studio 2010 - 程式碼度量

回應

  • # re: 命名-Glossary的建立 by hectorlee369

    比較好奇請問貴公司是什麼樣的角色來負責建立? 而那些角色協助? User單位的參與方式是?

    2011/12/16 上午 12:08 | 回覆

  • # re: 命名-Glossary的建立 by 91

    to hectorlee369 :

    之前的經驗是SA+developer要知道有這件事,這是溝通的基準。

    誰建立,無所謂。通常會請SA先建立一份,在這個系統的domain中會使用到的term,請他們在系統分析開立規格或描述需求時,就用這一份term。

    dev在implement的時候,就會碰到這些term,沒有的,就請SA補。

    這些term很有機會是從需求訪談中建立User Story/Use Case中的description中所建立的。


     

    2011/12/16 上午 12:43 | 回覆

  • # re: 命名-Glossary的建立 by 91

    to hectorlee369 :

    另外,在做domain model或是有所謂的顧問來當domain expert時,也都會引用或產出這些domain term。
     

    2011/12/16 上午 12:44 | 回覆

  • # re: 命名-Glossary的建立 by hectorlee369

    有做到以公司domain來建立共同使用的glossary, 意謂可以跨系統 嗎? 之前比較常遇到單一系統很容易建立, 但要再向上就很困難, 除了權責問題外, 同一term 但在不同的使用單位, 就會有不同的慣例差異.

    2011/12/16 上午 10:35 | 回覆

  • # re: 命名-Glossary的建立 by 91

    to hectorlee369 :

    CMMI => 流程資產館,如果有,應該會放在類似這樣的單位裡面。

    跨系統,一定可以啊。跨domain的結合可能就比較困難。

    2011/12/16 上午 10:53 | 回覆

  • # re: 命名-Glossary的建立 by 91

    to hectorlee369 :

    但落實面還是很局部就是了...這種東西是需要統整的推動...好的工法沒有好的實踐,一切也都是屁囉。
     

    2011/12/16 上午 10:54 | 回覆

  • # re: 命名-Glossary的建立 by hectorlee369

    除了您推的工具外, 我最常用的是xmind來建立私有的glossary, 第一層用單一字元, 第二層接完整字, 再加上一堆連結.

    如: "S" -> "Subscription"

                -> "合" -> "合同" 

                            -> "合約"  

    增加記憶, 就算過好幾年再回頭看, 也可以比較快上手

    2011/12/16 上午 11:08 | 回覆

  • # re: 命名-Glossary的建立 by 91

    to hectorlee369 :

    Xmind的缺點是不好share跟同步編輯。

    我自己是幾乎啥都用Xmind來存,但只限第一版。一旦export成不同的格式後,就無法再還原成xmind來使用。

    但Glossary是極有可能碰到同步編輯的情況。另外,也不是每個人都熟悉Xmind。

    還有一個問題,Xmind的搜尋功能做的不好。
     

    2011/12/16 下午 12:32 | 回覆

登入後使用進階評論

Please add 7 and 1 and type the answer here: