粗看日本軟件設(shè)計(jì)文檔

1、粗看日本軟件設(shè)計(jì)文檔作為對日開發(fā)的一員，應(yīng)該多學(xué)習(xí)日方的長處，比如說文檔。今天有幸拿到一份同行兄弟給我的對日外包軟件設(shè)計(jì)文檔，很平常的Excel文檔，打開一看內(nèi)容卻感到非常不一般，以前聽說過日本IT企業(yè)的“認(rèn)真地死板”，今天算是感受到了。這份文檔分8個(gè)sheet，每個(gè)sheet明確針對不同描述領(lǐng)域，分別為：鏈接、版本修正、軟件架構(gòu)和業(yè)務(wù)物理模型、界面原型、界面原形元素設(shè)定（包含初始化）、界面原形元素?cái)?shù)據(jù)實(shí)現(xiàn)順序、動作實(shí)現(xiàn)順序、底層數(shù)據(jù)集描述和實(shí)現(xiàn)。怎么說呢？我算是看到過很多設(shè)計(jì)文檔的人了，國內(nèi)的、歐美的，這次加上日本的算是全了70%了，我不想對日本發(fā)什么感慨，我只是想從這份文檔本身出發(fā)談?wù)効捶?/p>

2、。1. 為什么要有獨(dú)立的鏈接頁面？其實(shí)這個(gè)問題我不用多說，但凡是在IT行業(yè)做過的都知道這個(gè)行業(yè)有個(gè)很大的特色：早先沒什么文檔，自從CMM能增加企業(yè)光亮開始，文檔一夜之間就鋪天蓋地的出來了，甚至有段時(shí)間國內(nèi)出現(xiàn)了文檔容量攀比態(tài)度，各個(gè)公司之間，每個(gè)IT從業(yè)人員之間相互比對誰擁有的文檔多，多意味著什么？專業(yè)啊！問題是文檔多了管理這些文檔也麻煩了，不是丟了就是被某些糊涂蛋刪除了，幸好聰明的國人想到了配置管理，我把這些文檔分分類放到配置管理庫那么就一切OK了。我曾經(jīng)入職過一家國內(nèi)的大公司，第一天上班“師傅”就帶給我一個(gè)10G的資料讓我“學(xué)習(xí)”，我對這些文檔的第一個(gè)印象就是支離破碎，看完這個(gè)剛有點(diǎn)感覺想

3、看下面的時(shí)候，找不到后面的資料了，當(dāng)我找到后面資料時(shí)思想全亂了，一天下來頭昏腦漲，這也是我看到的最講究邏輯的行業(yè)做的最糟糕邏輯的事情了！所以文檔有個(gè)鏈接就非常好了，你可以讓每個(gè)孤立的文檔連成一個(gè)整體，讓閱讀者的思維通暢起來?；剡^頭我重新看了一下RUP2000，里面的文檔也是非常講究相互鏈接的，不知道為什么這么好的東西到了中國就“消失”了。2. 版本修正我覺得國內(nèi)只要是想正兒八經(jīng)做IT的都會在各自的文檔上加這個(gè)，只不過很多人沒有考慮一個(gè)閱讀的科學(xué)性，我以前的文檔全是在目錄后跟版本修正，這樣的話如果一份文檔變動非常頻繁，那么會造成頁面下拉厲害影響視覺。有個(gè)細(xì)節(jié)是，這份日本設(shè)計(jì)文檔的版本修訂區(qū)是根據(jù)

4、每個(gè)sheet做修訂大項(xiàng)的，每個(gè)sheet的細(xì)節(jié)分類變更包含其中，這樣可以跟蹤得很細(xì)。我們原來的文檔著這方面卻可以看出，細(xì)心的人寫的細(xì)，粗心的人寫的粗，總之在標(biāo)準(zhǔn)的文檔也會有不標(biāo)準(zhǔn)的地方。3. 軟件架構(gòu)和業(yè)務(wù)物理模型國內(nèi)也有，至少我以前接觸的文檔就有這方面的內(nèi)容，不過大多數(shù)是根據(jù)歐美風(fēng)格來的，大框架的描述的非常精美，如果你想看細(xì)節(jié)架構(gòu)和數(shù)據(jù)流就沒了。這份日文設(shè)計(jì)單獨(dú)開辟了一個(gè)sheet專門描述著描述這件事情，選用的圖形比較中規(guī)中矩，看了以后至少知道什么是入口，中間經(jīng)過何等處理，最后的輸出是什么或者什么形式?？磥砣毡静]有大規(guī)模推廣UML語言，他們就是用了office提供的圖形，我現(xiàn)在有些搞不清

5、楚了，國內(nèi)很多企業(yè)標(biāo)榜自己的設(shè)計(jì)完全UML化，出來的文檔很專業(yè)，結(jié)果是少數(shù)人看的懂，也許在某些國人眼里，設(shè)計(jì)就是那天上的月亮豈能讓凡夫俗子把玩乎？！文檔的細(xì)節(jié)是將模型中出現(xiàn)的文字都一一作了解釋，有點(diǎn)詞匯表的意思，但是沒有RUP中詞匯表那么大的作用范圍。4. 界面原型原型這東西最能讓閱讀者快速理解，2000年開始國內(nèi)很多IT企業(yè)就講究 快速原型開發(fā)方法，但是至今我沒看到過一份設(shè)計(jì)文檔帶原型，有的是有不過是后期開發(fā)完成后補(bǔ)的，這是聰明人做的事情。我看這份文檔，到這里我已經(jīng)完全明白要做什么了，至少我不會擔(dān)心我要自己設(shè)計(jì)什么稀奇古怪的東西。另外這個(gè)sheet標(biāo)注了項(xiàng)目說明，這樣結(jié)合原型我又能多理解很多

6、東西。說BUG大部分都是出現(xiàn)在需求和設(shè)計(jì)階段，如果你能100%理解你要做什么了，怎么會讓BUG穿透這么多層面流到客戶地方去？5. 界面原形元素設(shè)定到這里我作為一個(gè)曾經(jīng)的開發(fā)人員就要?jiǎng)邮譁?zhǔn)備做了，本sheet詳細(xì)描述了整個(gè)界面所用到的GUI元素，編程變量名稱，類型，長度，格式例子等等，還有GUI元素的坐標(biāo)。其實(shí)我理解到了開發(fā)階段，基本上就是光做不說的階段，你還能指望有幾個(gè)開發(fā)需要大量的 激情創(chuàng)造 才能生存下去？所以說，國內(nèi)的開發(fā)吃歐美的編程天才的毒蘑菇吃多了，產(chǎn)生了愉悅的精神幻覺，要知道圖靈只有一個(gè)他死在美國！6. 界面原形元素?cái)?shù)據(jù)實(shí)現(xiàn)順序這個(gè)要詳細(xì)看看，其實(shí)這個(gè)sheet我理解的也不是很好，但

7、是從含義來看是對GUI接收和反饋數(shù)據(jù)作的一個(gè)約定，哪些GUI元素是接收數(shù)據(jù)的，哪些GUI元素是反饋數(shù)據(jù)的，感覺就是很細(xì)節(jié)，是對前面一個(gè)sheet的補(bǔ)充。7. 動作實(shí)現(xiàn)順序國內(nèi)有個(gè)不好的習(xí)慣，習(xí)慣讓測試人員最后寫操作手冊，我不知道這個(gè)是誰發(fā)明的并且第一個(gè)開始，我只知道這樣的人在IT中對IT標(biāo)準(zhǔn)化是個(gè)莫大的嘲笑。這份sheet詳細(xì)描述了整個(gè)界面的操作動作，結(jié)合界面元素的不同組合詳細(xì)寫出業(yè)務(wù)可接收處理過程，如果你要寫操作手冊，只要結(jié)合VBS就可以快速生成一份XX軟件操作手冊，何必再勞師動眾讓本已經(jīng)疲于奔命的測試人員寫呢？8. 底層數(shù)據(jù)集描述和實(shí)現(xiàn)這部分詳細(xì)設(shè)計(jì)經(jīng)過GUI收集的數(shù)據(jù)最終存儲問題，國內(nèi)很多都有這方面的描述，這一塊日本作的實(shí)際了點(diǎn)，數(shù)據(jù)名稱跟前太GUI元素作了捆綁指定，看了整個(gè)設(shè)計(jì)就通暢了。最后要說明的是，這只是一份普普通通的日本軟件設(shè)計(jì)文檔，設(shè)計(jì)的內(nèi)容是一個(gè)很小