軟件項目中的文檔管理(下)
DevSuite系統中的文檔管理工具叫做KnowledgeWise,在以“知識為核心” 的理念中屬于核心地位,因為軟件開發過程中其實每個階段都需要接觸文檔的,從需求文檔到設計文檔到開發文檔到測試文檔再到發布文檔維護文檔,文檔自始至終一直是需要的,而且同一個文檔在整個過程可能是不斷發生更改的,所以通過KnowledgeWise跟蹤到每個更改對于開發過程來說或是及其重要的。
在KnowledgeWise中,文檔通過條目(Item)的方式來記錄的,也就是一個文檔對應一個條目,每個條目首先會有標題,描述,負責人,附件等字段組成,這些字段是自定義,可以根據你的需要而添加,這是所謂的基本屬性。然后條目還有一些高級屬性,比如權限控制,流程控制,版本控制,歷史跟蹤記錄等等,下面我就結合我們公司的實際流程來介紹一下這個系統。
1、首先對于那些制度類的,合同類的文檔,還有培訓類的文檔,我就不詳細介紹了,因為這些文檔不需要所有人都需要看到的,甚至有些需要保密的,更加不能讓很多人看到了。通過KnowledgeWise可以保存到只有相關人員才能看到的地方。KnowledgeWise可以為每個人針對每個文件,每個文件夾設置不同的權限,比如只讀,可以編輯,可刪除,可創建,當然還有不可見。所以你想設置如何復雜的權限組合都是沒問題的。(權限管理)
下面的兩個圖中,可以看到,我們可以為文件夾與文件設置不同的權限,而且是可以為不同的人設置不同的權限的,也就意味著,就是兩個人都是經理,我也可以讓一個文件只讓其中一個人看到。
2、然后就是一些設計文檔、開發文檔或者是FAQ之類的,這些文檔在實際過程中總是會經過很多流程最終產生一個成品,拿設計文檔來說吧,一個設計文檔從最初有意向,到最后成型,可能分為以下幾個部分:草稿—>初級審核—>繼續修改—>再次審核—>最后修改—>最后審核—>同意,這么幾個過程,而且每個過程中,負責處理的人也不一定是一樣的,草稿可能是有普通設計人員處理的,初級審核應該是設計組長處理,最后審核可能是設計主管處理,所以我們就需要設置嚴格的工作流程和相應的權限,流程剛才已經說過了,權限的話,意思是說,比如這個文檔在“初級審核”階段,必須設計組長才有權限去把這個文檔改變到繼續修改狀態,其他人沒有這個權限,甚至其他根本就沒法看到這個狀態下的那個文檔,這樣就確保是設計組長審核過才去繼續修改的,杜絕了有些人想盡快通過這個文檔而直接跳過流程改狀態了(當然,在KnowledgeWise中經過自定義設置是可以跳過流程改狀態的,當然正常情況下,這個必須是有一定權限的人才能做的,比如主管,經理等)(流程管理)
下面兩個圖是一個典型的文檔的流程的,第一個圖是在系統中自定義設置一個流程,第二個圖是系統客戶端的實際使用情況,可以看到,一個文檔從新建到最終成型在正常情況必須通過每個狀態的負責人的處理后,走完這個流程,這樣子基本上能夠保證一個文檔的質量。在系統中,每個能進入的系統的人,只要一進系統就可以看到自己需要處理的不同狀態的文檔任務,包括寫文檔、修改文檔和審核文檔。
3、軟件公司的做設計的人應該知道,對于一個設計文檔而言,會不斷地經過修改,即使是最后定稿了以后,可能一個新的改動過來,又得改,但是經常地我們也碰到了一種問題,就是我改完了,但是發現改錯了,想看看原來是怎么樣了,或者客戶不滿意想改回一個禮拜之前那個設計,總之就是我想還能看到這個文檔每次改動時內容,然后進行一些回滾操作,或者有時候需要對兩個不同版本的內容進行比較,看看到底做了哪些改動,改動前是什么,改動后是什么。(變更管理,版本管理)
在KnowledgeWise中,對一個文檔條目,每一次操作都能用快照方式記錄一個版本,所謂快照方式,就是類似一個拍照功能,把該版本文檔的相關內容拍下來,以后只能看,不能改。當然,你可以設置不讓每次修改都保存版本,只修改一些關鍵地方的地方才去保存一個版本,不然版本太多,以后比照起來也挺累人的。
對于保存下來的版本,主要有三個用處,
第一個當然是去看嘮,可以看看在過去某個時段,這個文檔是啥內容;
第二個內容就是回滾作用,就是說如果一旦我這個文檔修改了一下,覺得不對,想恢復到修改前的樣子,就可以回滾一下,當然你是可以回滾到任何已經保存下來的版本里的,那么那個版本里的內容將會覆蓋當前內容,所以一般情況下如果想回滾的話,你可以先手動做個版本保存,這個在KnowledgeWise中是允許的,而且即使做了回滾,所有的已經保存的版本還是不會受影響的。
第三個作用就是兩個版本間的相互對比,有時候我們作了修改后,想對比一下兩個版本之間到底有什么不一致,究竟改了多少地方,一旦我們用了對比功能以后,就可以把這個文檔的所有字段在不同版本間進行一一對比,有修改的地方會被自動標記,例如這個版本比那個版本就是刪除了一段話,這樣子的話,對比的時候,被刪除的這段話就會自動加上顏色,并且會加上一個刪除的線,一目了然。(關于對比這個功能,有些版本控制管理軟件其實做得更好,類似Subversion,所以KnowledgeWise也提供了跟Subversion集成的效果,有任何文件作為附件放到一個文檔里去的時候,可以同時被自動提交到Subversion中,這樣子,就可以對附件也進行對比了)
下面的圖就是版本保存的地方。
4、類似FAQ這些文檔,其實最終我們做完后是給我們的客戶用的,也就是給他們看的,作為幫助文檔的方式,所以放在系統中的話,就不太適合他們去看,可看性不好,所以KnowledgeWise提供了一種Wiki功能,可以將指定的文檔用Wiki方式給用戶看,下面就是一個典型的FAQ在線幫助的截圖。
5、另外的話,KnowledgeWise還支持直接由Word或者PDF文檔中直接把內容導入到系統中作為一個條目,甚至可以把Word/PDF中分段的內容導成幾個相關聯的條目,當然也支持導出功能和報表功能了。
6、KnowledgeWise的文檔管理支持服務器-瀏覽器形式的訪問,所以只要你能訪問你們公司的網頁,你就能訪問到你想要的文檔,局域網與廣域網訪問起來沒有任何區別。
總的來說,KnowledgeWise是一個非常棒的文檔管理系統,完全滿足了我們公司的要求,甚至超出了不少期待,因為它能跟我們買的其他TechExcel產品做無縫的集成,也就是說一個文檔我可以在不同產品中都能看到,如果有更新我也能一下子看到,對于我們公司的軟件開發過程是相當有幫助的。
posted on 2011-11-16 11:55 順其自然EVO 閱讀(153) 評論(0) 編輯 收藏 所屬分類: 管理方向