文檔、代碼審查管理及解決方案

1、精選優(yōu)質(zhì)文檔-傾情為你奉上文檔、代碼審查文檔、代碼目錄結(jié)構(gòu)4.項(xiàng)目監(jiān)控5.需求管理6.項(xiàng)目溝通6.1.內(nèi)部交流6.2.與客戶交流7.配置管理第一、文檔、代碼審查時(shí)的要有目的性，針對(duì)性。文檔、代碼審查的根本目的是保證品質(zhì)，但不能把它做為一次文檔、代碼審查工作的直接目標(biāo)，這樣的目標(biāo)太泛泛，讓我們?cè)谖臋n、代碼審查工作過程中抓不住重點(diǎn)。第二、文檔、代碼審查工作時(shí)參與的角色要合理。參與文檔、代碼審查工作的人大多是技術(shù)合格，但業(yè)務(wù)不合格，這樣對(duì)于一些復(fù)雜的業(yè)務(wù)邏輯問題就很難發(fā)現(xiàn)，從而使得這些業(yè)務(wù)邏輯問題在文檔、代碼審查的過程中蒙混過關(guān)。第三、文檔、代碼審查工作不能過于集中，一次文檔、代碼審查的代碼量太大。

2、在有限的幾個(gè)小時(shí)內(nèi)，面對(duì)上千行，甚至更多的代碼時(shí)，再有耐心的人也難免產(chǎn)生視覺疲勞。準(zhǔn)備要充足，對(duì)于要文檔、代碼審查的缺少必要的審查規(guī)范和標(biāo)準(zhǔn)。在文檔、代碼審查過程中，我們有文檔、代碼編寫規(guī)范，代碼的設(shè)計(jì)規(guī)范、業(yè)務(wù)的邏輯規(guī)范和標(biāo)準(zhǔn)。那么，我們應(yīng)該怎樣做，才能使文檔、代碼審查工作保質(zhì)而且高效呢？一個(gè)標(biāo)準(zhǔn)的文檔、代碼審查工作應(yīng)該分為三個(gè)階段：一、事前準(zhǔn)備階段評(píng)審規(guī)范和標(biāo)準(zhǔn)：在一次文檔、代碼審查前，掌握代碼分析和評(píng)審技術(shù)、掌握自動(dòng)化代碼分析工具的使用，文檔、代碼審查產(chǎn)生成本估算，代碼文檔歸檔服務(wù)器，要懂開發(fā)的人員參與文檔、代碼審查，代碼評(píng)審以公司內(nèi)部的文檔、代碼標(biāo)準(zhǔn)為基礎(chǔ)。在文檔、代碼審查前設(shè)計(jì)確定評(píng)

3、審規(guī)范和標(biāo)準(zhǔn)是必要，通過規(guī)范和標(biāo)準(zhǔn)我們?cè)趯彶檫^程中可以有據(jù)可依，有理可循，而且還可以做到標(biāo)準(zhǔn)統(tǒng)一。代碼評(píng)審的目的：保證文檔完善、代碼質(zhì)量、學(xué)習(xí)和交流，確保參照良好的編碼標(biāo)準(zhǔn)，產(chǎn)生高質(zhì)量，可維護(hù)的代碼及供參考的文檔資料庫。二、實(shí)施階段。充分的事前準(zhǔn)備，只是做好文檔、代碼審查工作的前提，文檔、代碼評(píng)審應(yīng)按照一定的流程作業(yè)，這樣可以降低評(píng)審成本，提高評(píng)審效率。代碼評(píng)審流程介紹如下：1、文檔、代碼評(píng)審發(fā)起。代碼評(píng)審發(fā)起要有專門負(fù)責(zé)人，負(fù)責(zé)人要控制整個(gè)評(píng)審過程。負(fù)責(zé)人負(fù)責(zé)確定評(píng)審范圍、評(píng)審人、評(píng)審結(jié)果交付日期和組織召開評(píng)審會(huì)議。負(fù)責(zé)人還要編寫代碼評(píng)審評(píng)審點(diǎn)列表，代碼評(píng)審評(píng)審點(diǎn)列表列舉出代碼評(píng)審過程重點(diǎn)檢

4、查的項(xiàng)目供評(píng)審人逐一檢查代碼。2、文檔、代碼審查的對(duì)象。在準(zhǔn)備文檔、代碼審查代碼對(duì)象時(shí)，我們要注意代碼的數(shù)量，如果代碼量比較大，要對(duì)代碼進(jìn)行必要的分解，確定其中的關(guān)鍵代碼，對(duì)關(guān)鍵代碼進(jìn)行文檔、代碼審查，可以達(dá)到舉一反三的目的。負(fù)責(zé)人發(fā)起代碼評(píng)審。告知評(píng)審人代碼的評(píng)審范圍，確定被評(píng)審代碼的版本號(hào)，告知評(píng)審人評(píng)審結(jié)果的交付時(shí)間。負(fù)責(zé)人還應(yīng)該為評(píng)審人提供相關(guān)的資料例如編碼規(guī)約等。3、文檔、代碼審查內(nèi)容。我們對(duì)代碼的審查內(nèi)容很多，如代碼的編寫是否規(guī)范（注釋的書寫格式、命名規(guī)范等）、技術(shù)處理規(guī)范（異常處理、日志處理、代碼組織結(jié)構(gòu)等）、業(yè)務(wù)實(shí)現(xiàn)等。我們不能希望通過一次文檔、代碼審查工作，完成所有這些內(nèi)容的

5、審查，因此我們必須設(shè)定本次文檔、代碼審查工作內(nèi)容界限，確定審查重點(diǎn)；要做代碼靜態(tài)分析，在不執(zhí)行的情況下對(duì)代碼進(jìn)行評(píng)估的過程，類型檢查，安全審查，比較靜態(tài)安全分析工具的最佳方法是使用一些工具分析同一代碼并比較其結(jié)果。如：命令行參數(shù)、配置文件、從數(shù)據(jù)庫中檢索出來的數(shù)據(jù)、環(huán)境變量、網(wǎng)絡(luò)服務(wù)、注冊(cè)表值、臨時(shí)文件，不要盲目依賴數(shù)據(jù)庫的數(shù)據(jù)來保證應(yīng)用程序的正確運(yùn)行。評(píng)審人評(píng)審文檔、代碼。評(píng)審人按照負(fù)責(zé)人告知的評(píng)審范圍，認(rèn)真評(píng)審代碼、文檔，填寫評(píng)審報(bào)告，在規(guī)定的時(shí)間內(nèi)完成評(píng)審。填寫評(píng)審報(bào)告要明確的描述問題發(fā)現(xiàn)點(diǎn)的位置，要寫清代碼文件的版本號(hào)，問題點(diǎn)的行號(hào)。4、選擇文檔、代碼審查工作的實(shí)施方式。文檔、代碼審查

6、工作有很多形式可供我們選擇，我們可以根據(jù)實(shí)際情況選擇桌面式文檔、代碼審查、演示講解式文檔、代碼審查、一對(duì)一的座位文檔、代碼審查等等。負(fù)責(zé)人將評(píng)審結(jié)果轉(zhuǎn)交給代碼編寫人，編寫人認(rèn)真核對(duì)評(píng)審報(bào)告，修正代碼。編寫人要認(rèn)真填寫評(píng)審報(bào)告，要寫清修正后代碼文件的版本號(hào)，修正點(diǎn)的行號(hào)。5、召開評(píng)審會(huì)議。會(huì)上逐一對(duì)評(píng)審報(bào)告認(rèn)真分析，評(píng)審人和代碼編寫人要對(duì)每一項(xiàng)評(píng)審結(jié)果達(dá)成共識(shí)。準(zhǔn)確記錄。對(duì)于文檔、代碼審查過程發(fā)現(xiàn)的問題，我們必須清晰準(zhǔn)確的記錄，可以使用問題點(diǎn)記錄單，明確記錄的項(xiàng)目和內(nèi)容。6、負(fù)責(zé)人編寫評(píng)審總結(jié)。將評(píng)審中總結(jié)出的問題和經(jīng)驗(yàn)通知給項(xiàng)目組成員。并且把完整的所有文檔、代碼上傳到服務(wù)器存檔，通過版本控制工

7、具來管理（如：SVN、VSS等工具），這樣可以有效的共控制文檔和代碼的完整性，供公司后期參考學(xué)習(xí)使用三，事后跟蹤跟蹤。文檔、代碼審查結(jié)束后，對(duì)發(fā)現(xiàn)的問題，首先需要確定以下內(nèi)容。1問題點(diǎn)的難易程度以及影響的范圍；2解決問題的責(zé)任者和問題點(diǎn)修正結(jié)果的確認(rèn)者；3解決問題點(diǎn)的時(shí)限。其次是對(duì)于修正問題責(zé)任者，在問題點(diǎn)的修正過程中，要三方面內(nèi)容的記錄。1問題點(diǎn)的原因；2解決問題點(diǎn)的對(duì)策；3修正的內(nèi)容。做為修正結(jié)果的確認(rèn)者，必須按照事前約定的時(shí)限及時(shí)的對(duì)修正結(jié)果進(jìn)行全面的確認(rèn)。文檔、代碼管理如何防止員工離職時(shí)擅自拷貝帶走機(jī)密資料？ 如何防止設(shè)計(jì)文檔、程序源代碼等機(jī)密信息等泄露給競(jìng)爭(zhēng)對(duì)手？ 如何讓員工高效地分

8、享企業(yè)知識(shí)的同時(shí)又能保護(hù)機(jī)密文件的安全？現(xiàn)狀分析知識(shí)經(jīng)濟(jì)時(shí)代，企業(yè)的核心競(jìng)爭(zhēng)力將更多地來自技術(shù)發(fā)明、專利、創(chuàng)新等"軟資產(chǎn)"，隨著信息系統(tǒng)應(yīng)用的普及，這些“軟資產(chǎn)”體現(xiàn)為大量的文檔、代碼。在日常工作中，需要數(shù)十甚至數(shù)百位員工協(xié)同工作，不可避免地需要涉及機(jī)密文檔、代碼，如何很好地保護(hù)這些重要資料，成為擺在企業(yè)面前的一個(gè)難題。泄密源自內(nèi)部雇員故意所為；文檔、代碼泄密所造成的損失是沒有計(jì)算標(biāo)準(zhǔn)的。在內(nèi)部人員故意的泄密行為面前，企業(yè)網(wǎng)絡(luò)中的防火墻、入侵檢測(cè)以及各種文件加密等技術(shù)手段均不能起到真正的防范作用。通過尋求更加完善的技術(shù)手段保護(hù)機(jī)密文檔、代碼，是企業(yè)必然的選擇。雖然企業(yè)可以通

9、過各種規(guī)章制度和一些技術(shù)手段對(duì)機(jī)密文檔、代碼進(jìn)行管理，但是傳統(tǒng)的安全措施和技術(shù)手段無法消除企業(yè)機(jī)密文檔、代碼泄漏的隱患。與此同時(shí)不可避免地因?yàn)榘踩?，?dǎo)致工作效率下降以及公司資源浪費(fèi)，不利于有效利用現(xiàn)有文檔和部門間的協(xié)同工作。文檔、代碼保密解決方案采用機(jī)密文檔、代碼集中存儲(chǔ)、統(tǒng)一管理、用戶權(quán)限控制的方式，將機(jī)密文檔集中保存在文檔中心并與客戶端設(shè)備完全隔離，通過版本控制工具及管理工具，使授權(quán)用戶可以在權(quán)限范圍內(nèi)正常使用，但無法以任何形式復(fù)制到客戶端設(shè)備，從根本上杜絕了機(jī)密文檔的泄漏，保護(hù)企業(yè)的核心競(jìng)爭(zhēng)力?？蛻舳丝梢员还芾砘蚪沟牟僮靼ǎ簷C(jī)密電子文檔不會(huì)以任何形式（硬盤、內(nèi)存等）保存在客戶端設(shè)

10、備上，用戶無法以任何形式將機(jī)密電子文檔復(fù)制到客戶端的其他存儲(chǔ)設(shè)備上，包括硬盤存儲(chǔ)、軟盤存儲(chǔ)、光盤存儲(chǔ)、U盤存儲(chǔ)以及其他客戶端存儲(chǔ)設(shè)備。可以管理或禁止客戶端對(duì)機(jī)密文檔、代碼的各種輸出操作，包括打印、文檔編輯中的復(fù)制/粘貼、屏幕拷貝等。使用代碼、文檔管理系統(tǒng)，幫助企業(yè)建立全面的文檔管理與授權(quán)機(jī)制平臺(tái)，用戶可以對(duì)授權(quán)的文件與信息進(jìn)行快速的查找、閱讀與編輯，有效解決企業(yè)文檔版本多、查找不方便甚至丟失等一系列問題，提高工作效率?？梢耘浜掀髽I(yè)各種的應(yīng)用系統(tǒng)，構(gòu)建安全、靈活、適應(yīng)性強(qiáng)的應(yīng)用訪問平臺(tái)，既滿足保密需求，同時(shí)滿足業(yè)務(wù)需求。系統(tǒng)以文件或文件夾為基本單元向用戶分配操作權(quán)限，只有擁有相應(yīng)權(quán)限的用戶才能執(zhí)

11、行對(duì)應(yīng)的操作。用戶權(quán)限細(xì)分為：無權(quán)限（用戶根本無法看到或搜索到該文件）、列表（只能看到或搜索到文件名）、讀?。ㄓ脩艨梢宰x取到文件的內(nèi)容）、修改（用戶可以對(duì)文件進(jìn)行修改）、管理（用戶可以對(duì)文件進(jìn)行授權(quán)），這些權(quán)限均可以做出時(shí)間期限的規(guī)定并隨時(shí)動(dòng)態(tài)調(diào)整。用戶操作日志：自動(dòng)記錄每個(gè)用戶的重要操作，包括文檔操作，賬戶操作，權(quán)限修改操作等。日志記錄可以在線查看。方案簡(jiǎn)述企業(yè)采用機(jī)密電子文檔集中存儲(chǔ)、統(tǒng)一管理、用戶訪問權(quán)限控制的方式，將機(jī)密文檔、代碼集中保存在機(jī)密文件服務(wù)器上，通過文檔、代碼管理系統(tǒng)管理機(jī)密文件，用戶通過訪問設(shè)備的方式得到對(duì)機(jī)密文件的訪問授權(quán)，得到授權(quán)的用戶在訪問機(jī)密文件的全過程中，這些文

12、件不會(huì)以任何形式存在于用戶使用的PC機(jī)的內(nèi)存或硬盤中，從而徹底防止了機(jī)密文件的泄密可能。建立網(wǎng)絡(luò)機(jī)密區(qū)，將應(yīng)用系統(tǒng)集中部署在嚴(yán)密保護(hù)的服務(wù)器上，通過網(wǎng)關(guān)授權(quán)用戶使用，從根本上杜絕機(jī)密信息的泄漏途徑，達(dá)到既保護(hù)企業(yè)機(jī)密信息，又不影響工作效率的目的。文檔、代碼保密解決方案可以配合企業(yè)現(xiàn)有應(yīng)用系統(tǒng)，構(gòu)建企業(yè)的綜合信息安全平臺(tái)。在本方案中，涉密的應(yīng)用系統(tǒng)（包括開發(fā)工具，PDM、文檔閱讀和管理工具、版本控制系統(tǒng)等）和機(jī)密文件集中部署在機(jī)密區(qū)網(wǎng)絡(luò)，機(jī)密區(qū)的應(yīng)用系統(tǒng)和文檔服務(wù)器與外部網(wǎng)絡(luò)完全隔離，通過應(yīng)用系統(tǒng)的操作界面。使用權(quán)限范圍內(nèi)的各種系統(tǒng)和工具、根據(jù)授權(quán)，瀏覽或修改機(jī)密文檔，訪問應(yīng)用系統(tǒng)，所有的操作都集中在服務(wù)器端，客戶端任何對(duì)文檔的輸出、拷貝等行為均被禁止，使用者不能將機(jī)密文檔本身或者內(nèi)容復(fù)制到客戶端的任何設(shè)備上。將現(xiàn)在的應(yīng)用系統(tǒng)納入統(tǒng)一的信息安全平臺(tái)，在兼顧高安全性同時(shí)又不妨礙員工進(jìn)行正常的工作。文檔、代碼保密方案是一個(gè)綜合的文檔安全解決方案，能夠?qū)崿F(xiàn)任何終端設(shè)備與文檔服務(wù)器的網(wǎng)絡(luò)隔離，有效杜絕各種文檔泄漏的可能性。它集成了企業(yè)內(nèi)部的安全需求，如集中的文檔管理、有效的數(shù)據(jù)傳輸控制、客戶端不留