天天看點

軟體項目中的文檔管理(下)

  在knowledgewise中,文檔通過條目(item)的方式來記錄的,也就是一個文檔對應一個條目,每個條目首先會有标題,描述,負責人,附件等字段組成,這些字段是自定義,可以根據你的需要而添加,這是所謂的基本屬性。然後條目還有一些進階屬性,比如權限控制,流程控制,版本控制,曆史跟蹤記錄等等,下面我就結合我們公司的實際流程來介紹一下這個系統。

  1、首先對于那些制度類的,合同類的文檔,還有教育訓練類的文檔,我就不詳細介紹了,因為這些文檔不需要所有人都需要看到的,甚至有些需要保密的,更加不能讓很多人看到了。通過knowledgewise可以儲存到隻有相關人員才能看到的地方。knowledgewise可以為每個人針對每個檔案,每個檔案夾設定不同的權限,比如隻讀,可以編輯,可删除,可建立,當然還有不可見。是以你想設定如何複雜的權限組合都是沒問題的。(權限管理)

  下面的兩個圖中,可以看到,我們可以為檔案夾與檔案設定不同的權限,而且是可以為不同的人設定不同的權限的,也就意味着,就是兩個人都是經理,我也可以讓一個檔案隻讓其中一個人看到。

軟體項目中的文檔管理(下)
軟體項目中的文檔管理(下)

 下面兩個圖是一個典型的文檔的流程的,第一個圖是在系統中自定義設定一個流程,第二個圖是系統用戶端的實際使用情況,可以看到,一個文檔從建立到最終成型在正常情況必須通過每個狀态的負責人的處理後,走完這個流程,這樣子基本上能夠保證一個文檔的品質。在系統中,每個能進入的系統的人,隻要一進系統就可以看到自己需要處理的不同狀态的文檔任務,包括寫文檔、修改文檔和稽核文檔。

軟體項目中的文檔管理(下)
軟體項目中的文檔管理(下)

  3、軟體公司的做設計的人應該知道,對于一個設計文檔而言,會不斷地經過修改,即使是最後定稿了以後,可能一個新的改動過來,又得改,但是經常地我們也碰到了一種問題,就是我改完了,但是發現改錯了,想看看原來是怎麼樣了,或者客戶不滿意想改回一個禮拜之前那個設計,總之就是我想還能看到這個文檔每次改動時内容,然後進行一些復原操作,或者有時候需要對兩個不同版本的内容進行比較,看看到底做了哪些改動,改動前是什麼,改動後是什麼。(變更管理,版本管理)

  在knowledgewise中,對一個文檔條目,每一次操作都能用快照方式記錄一個版本,所謂快照方式,就是類似一個拍照功能,把該版本文檔的相關内容拍下來,以後隻能看,不能改。當然,你可以設定不讓每次修改都儲存版本,隻修改一些關鍵地方的地方才去儲存一個版本,不然版本太多,以後比照起來也挺累人的。

對于儲存下來的版本,主要有三個用處,

  第一個當然是去看唠,可以看看在過去某個時段,這個文檔是啥内容;

  第二個内容就是復原作用,就是說如果一旦我這個文檔修改了一下,覺得不對,想恢複到修改前的樣子,就可以復原一下,當然你是可以復原到任何已經儲存下來的版本裡的,那麼那個版本裡的内容将會覆寫目前内容,是以一般情況下如果想復原的話,你可以先手動做個版本儲存,這個在knowledgewise中是允許的,而且即使做了復原,所有的已經儲存的版本還是不會受影響的。

  第三個作用就是兩個版本間的互相對比,有時候我們作了修改後,想對比一下兩個版本之間到底有什麼不一緻,究竟改了多少地方,一旦我們用了對比功能以後,就可以把這個文檔的所有字段在不同版本間進行一一對比,有修改的地方會被自動标記,例如這個版本比那個版本就是删除了一段話,這樣子的話,對比的時候,被删除的這段話就會自動加上顔色,并且會加上一個删除的線,一目了然。(關于對比這個功能,有些版本控制管理軟體其實做得更好,類似subversion,是以knowledgewise也提供了跟subversion內建的效果,有任何檔案作為附件放到一個文檔裡去的時候,可以同時被自動送出到subversion中,這樣子,就可以對附件也進行對比了)

  下面的圖就是版本儲存的地方。

軟體項目中的文檔管理(下)

  4、類似faq這些文檔,其實最終我們做完後是給我們的客戶用的,也就是給他們看的,作為幫助文檔的方式,是以放在系統中的話,就不太适合他們去看,可看性不好,是以knowledgewise提供了一種wiki功能,可以将指定的文檔用wiki方式給使用者看,下面就是一個典型的faq線上幫助的截圖。

軟體項目中的文檔管理(下)

  5、另外的話,knowledgewise還支援直接由word或者pdf文檔中直接把内容導入到系統中作為一個條目,甚至可以把word/pdf中分段的内容導成幾個相關聯的條目,當然也支援導出功能和報表功能了。

  6、knowledgewise的文檔管理支援伺服器-浏覽器形式的通路,是以隻要你能通路你們公司的網頁,你就能通路到你想要的文檔,區域網路與廣域網通路起來沒有任何差別。

  總的來說,knowledgewise是一個非常棒的文檔管理系統,完全滿足了我們公司的要求,甚至超出了不少期待,因為它能跟我們買的其他techexcel産品做無縫的內建,也就是說一個文檔我可以在不同産品中都能看到,如果有更新我也能一下子看到,對于我們公司的軟體開發過程是相當有幫助的。

本文出自seven的測試人生公衆号最新内容請見作者的github頁:http://qaseven.github.io/