軟件項目文檔生成方法和軟件項目文檔生成器的制造方法
【專利摘要】一種軟件項目文檔生成方法和軟件項目文檔生成器，所述方法包括：獲取需要生成的項目對象中的原子對象的標(biāo)識信息；查找與所述原子對象的標(biāo)識信息匹配的項目文檔庫，將所述匹配的項目文檔庫中的原子文檔內(nèi)容進(jìn)行復(fù)制；將所復(fù)制的原子文檔內(nèi)容粘貼到所獲取的項目文檔模板中的對應(yīng)位置。采用上述方法和軟件項目文檔生成器可以自動生成軟件項目文檔，能夠有效復(fù)用或者繼承已有項目的軟件項目文檔內(nèi)容，可以避免人為錯誤，提高軟件開發(fā)效率。
【專利說明】軟件項目文檔生成方法和軟件項目文檔生成器

【技術(shù)領(lǐng)域】
[0001]本發(fā)明涉及軟件測試項目管理【技術(shù)領(lǐng)域】，尤其涉及一種軟件項目文檔生成方法和軟件項目文檔生成器。

【背景技術(shù)】
[0002]軟件開發(fā)文檔是軟件開發(fā)使用和維護(hù)過程中的必備資料，能夠提高軟件開發(fā)效率，保證軟件質(zhì)量。軟件開發(fā)通常是按照項目進(jìn)行，每個項目的開發(fā)設(shè)計人員人工獨立編寫各自項目的軟件項目文檔。由于軟件開發(fā)是個復(fù)雜的系統(tǒng)工程，軟件項目文檔通常篇幅較長，每個項目的開發(fā)設(shè)計人員都需要花費大量精力來編寫軟件項目文檔，為了避免編寫錯誤，還需要花費大量時間進(jìn)行核查，一旦發(fā)生錯誤，很難追溯錯誤根源，會導(dǎo)致軟件開發(fā)的反復(fù)，甚至影響項目進(jìn)度。
[0003]由于現(xiàn)有軟件開發(fā)過程中，各個項目的軟件開發(fā)文檔都是獨立編寫，項目之間缺少全局的規(guī)劃整合，各個項目之間的開發(fā)文檔無法有效地復(fù)用或者繼承，且人工獨立編寫軟件項目文檔的工作量巨大，容易出錯。綜上，現(xiàn)有的軟件開發(fā)文檔編寫存在人工編寫效率低，容易出錯的問題。


【發(fā)明內(nèi)容】

[0004]本發(fā)明解決的問題是現(xiàn)有軟件項目文檔由人工編寫導(dǎo)致的效率低，容易出錯的問題。
[0005]為解決上述問題，本發(fā)明提供一種軟件項目文檔生成方法，所述方法包括:獲取需要生成的項目對象中的原子對象的標(biāo)識信息；查找與所述原子對象的標(biāo)識信息匹配的項目文檔庫，將所述匹配的項目文檔庫中的原子文檔內(nèi)容進(jìn)行復(fù)制；將所復(fù)制的原子文檔內(nèi)容粘貼到所獲取的項目文檔模板中的對應(yīng)位置。
[0006]可選的，所述方法還包括:當(dāng)確定所述原子對象的標(biāo)識不匹配或所述原子對象的版本不匹配時，輸出錯誤提示信息，提示錯誤原因。
[0007]可選的，所述原子對象的標(biāo)識信息包括:所述原子對象的名稱和所述原子對象的版本信息。
[0008]可選的，所述原子對象所對應(yīng)的項目文檔庫存儲在本地。
[0009]可選的，所述原子對象所對應(yīng)的項目文檔庫存儲在網(wǎng)絡(luò)服務(wù)器上。
[0010]為解決上述問題，本發(fā)明實施例還提供了一種軟件項目文檔生成器，所述軟件項目文檔生成器包括:獲取單元，用于獲取需要生成的項目對象中的原子對象的標(biāo)識信息；信息提取單元，查找與所述獲取單元獲取的所述原子對象的標(biāo)識信息匹配的項目文檔庫，將所述匹配的項目文檔庫中的原子文檔內(nèi)容進(jìn)行復(fù)制；生成單元，用于將所述信息提取單元所復(fù)制的原子文檔內(nèi)容粘貼到所獲取的項目文檔模板中的對應(yīng)位置。
[0011]可選的，所述軟件項目文檔生成器還包括:信息提示單元，用于當(dāng)確定所述項目文檔庫中不存在與所述原子對象的標(biāo)識或者版本匹配的原子文檔內(nèi)容后，輸出錯誤提示信息以提示錯誤原因。
[0012]可選的，所述原子對象的標(biāo)識信息包括:所述原子對象的名稱和所述原子對象的版本信息。
[0013]可選的，所述原子對象所對應(yīng)的項目文檔庫存儲在本地。
[0014]可選的，所述原子對象所對應(yīng)的項目文檔庫存儲在網(wǎng)絡(luò)服務(wù)器上。
[0015]通過將軟件項目文檔內(nèi)容原子化，作為獨立的具有不同標(biāo)識信息和版本信息的原子對象的項目文檔庫進(jìn)行保存，在需要生成一個項目對象的軟件項目文檔時，首先獲取所需要生成的項目對象中的原子對象的標(biāo)識信息和版本信息，并調(diào)用與所述原子對象的標(biāo)識信息和版本信息匹配的項目文檔庫，將所述匹配的項目文檔庫中的原子文檔內(nèi)容進(jìn)行復(fù)制，并粘貼至所獲取的項目文檔模板中的對應(yīng)位置，合并生成所述項目對象對應(yīng)的軟件項目文檔，使得所生成的項目對象可以采用其他項目不同原子對象的原子文檔內(nèi)容，直接自動生成，從而有效地復(fù)用或者繼承了其他項目的軟件項目文檔內(nèi)容，因此可以提高軟件項目文檔生成效率，且由于是自動生成，可以避免人為錯誤，且將軟件項目文檔內(nèi)容原子化之后，便于追溯錯誤根源，因此可以進(jìn)一步提高軟件開發(fā)效率。

【專利附圖】

【附圖說明】
[0016]圖1是本發(fā)明實施例中軟件項目文檔生成方法流程圖；
[0017]圖2是本發(fā)明實施例中軟件項目文檔生成器結(jié)構(gòu)示意圖。

【具體實施方式】
[0018]為解決現(xiàn)有軟件開發(fā)中，各個項目的項目開發(fā)設(shè)計人員獨立編寫項目文檔工作量巨大，易于出錯，各個項目之間的開發(fā)文檔無法有效地復(fù)用或者繼承的問題，通過將現(xiàn)有的項目文檔內(nèi)容原子化，將原子化后的各個項目內(nèi)容作為合并生成一個項目文檔的最小單位，可稱為原子對象，所述原子對象所描述的對象相對獨立。每個軟件項目文檔內(nèi)容都可拆分為一系列的原子對象。
[0019]由于一個軟件項目的軟件項目文檔，通常并不是全新的，與其他已經(jīng)開發(fā)的項目之間，通常存在一定的可復(fù)用性或者繼承性，即可能存在很多與某個項目的軟件項目文檔相同的部分，或者可能是多個項目的軟件項目文檔疊加在一起，因此，將已開發(fā)項目的項目文檔內(nèi)容原子化，記錄原子化后的原子對象對應(yīng)的標(biāo)識信息，并將所述原子對象對應(yīng)的原子文檔內(nèi)容作為項目文檔庫進(jìn)行存儲。在需要生成一個新的項目對象的軟件項目文檔時，即可獲取所述項目對象所需要的原子對象的標(biāo)識信息，并調(diào)用與所述原子對象的標(biāo)識信息匹配的項目文檔庫，將所述匹配的項目文檔庫中的原子文檔內(nèi)容進(jìn)行復(fù)制，并粘貼到所獲取的項目文檔模板中的對應(yīng)位置，即可合并生成所述項目對象對應(yīng)的軟件項目文檔。
[0020]為使本發(fā)明的上述目的、特征和優(yōu)點能夠更為明顯易懂，下面結(jié)合附圖對本發(fā)明的具體實施例做詳細(xì)的說明。
[0021]參照圖1，本發(fā)明實施例提供了一種軟件項目文檔生成方法，以下通過步驟進(jìn)行詳細(xì)說明:
[0022]S101，獲取需要生成的項目對象中的原子對象的標(biāo)識信息。
[0023]如前所述，對于一個軟件開發(fā)團(tuán)隊所開發(fā)的大部分項目來說，通常不是一個全新的項目，而是通常與已完成的一個項目有很多相同的部分，對于已經(jīng)完成的項目，由于已經(jīng)經(jīng)過實踐驗證的，因此較為可靠，具有較好的穩(wěn)定性與可靠性，因此可以將已開發(fā)項目的項目文檔內(nèi)容原子化，記錄原子化后的原子對象對應(yīng)的標(biāo)識信息，并將所述原子對象對應(yīng)的原子文檔內(nèi)容作為項目文檔庫進(jìn)行存儲。
[0024]在具體實施中，所述原子對象的標(biāo)識信息可以包括所述原子對象的名稱和所述原子對象的版本信息。
[0025]例如，對于一個項目需求文檔，可以按照功能劃分為不同的功能模塊，為實現(xiàn)盡可能靈活的復(fù)用或繼承，所述功能模塊可以盡量原子化，即按功能分為獨立的最小單位，作為原子對象。
[0026]在具體實施中，為簡便起見，可以采用Excel數(shù)據(jù)表格的形式來管理項目，所有項目對象以及每個項目對象所對應(yīng)的各個原子對象的標(biāo)識信息均可以保存在所述Excel數(shù)據(jù)表格中?？梢岳斫獾氖牵部梢圆捎闷渌麑ｉT的工具來管理項目，例如，將所有的項目所涉及的各個原子對象放在專門的原子對象庫中進(jìn)行存儲，將各個原子對象所涉及的項目文檔庫也作為獨立的數(shù)據(jù)庫進(jìn)行存儲，通過專門的管理界面來選擇原子對象及調(diào)用相應(yīng)的項目文檔庫。
[0027]對于所述需要生成的項目對象，例如，一個項目的需求文檔,項目負(fù)責(zé)人可以根據(jù)所述項目的需求，選擇可以復(fù)用或繼承的現(xiàn)有項目的需求文檔中的原子對象的名稱及版本。
[0028]S102，查找與所述原子對象的標(biāo)識信息匹配的項目文檔庫，將所述匹配的項目文檔庫中的原子文檔內(nèi)容進(jìn)行復(fù)制。
[0029]在具體實施中，所述原子對象所對應(yīng)的項目文檔庫可以存儲在本地，也可以存儲在網(wǎng)絡(luò)服務(wù)器上。
[0030]例如，根據(jù)選擇的原子對象的名稱及版本信息，查找與所述原子對象的名稱及版本信息匹配的項目文檔庫，如果存在與所述原子對象的名稱及版本信息匹配的項目文檔庫，則將所述匹配的項目文檔庫中的原子文檔內(nèi)容進(jìn)行復(fù)制。
[0031]由于一個項目通常由一系列的原子對象構(gòu)成，因此在具體實施中，可以按照順序就每一個所選擇的原子對象，依次查找與所選擇的原子對象匹配的項目文檔庫。例如，在Excel表格中所選擇的各個原子對象按照順序依次排列，即可按照表格順序依次對每一個原子對象進(jìn)行匹配，查找與所述原子對象匹配的項目文檔庫，并復(fù)制所述匹配的項目文檔庫中的原子文檔內(nèi)容。
[0032]S103，將所復(fù)制的原子文檔內(nèi)容粘貼到所獲取的項目文檔模板中的對應(yīng)位置。
[0033]預(yù)先可以設(shè)置一個固定的項目文檔模板并保存?？梢愿鶕?jù)不同的項目需求設(shè)置固定的項目文檔模板，例如，對于項目的功能需求，可以設(shè)置《項目需求文檔》模板，還可以設(shè)置其他滿足軟件開發(fā)需求的技術(shù)文檔模板，例如《編譯手冊》、《數(shù)據(jù)庫文檔》等軟件開發(fā)過程中需要的項目文檔模板。
[0034]在具體實施中，可以在所述項目文檔中預(yù)先設(shè)定每個可能的原子對象對應(yīng)的原子文檔內(nèi)容的順序和位置，也可以將所復(fù)制的原子對象的原子文檔內(nèi)容按照原子對象的執(zhí)行順序進(jìn)行粘貼。
[0035]當(dāng)每一個原子對象的原子文檔內(nèi)容復(fù)制完成后，即可按照順序依次粘貼到所獲取的項目文檔中的對應(yīng)位置。
[0036]可以理解的是，在具體實施中，對于一個新的項目，很可能存在已有的所有項目文檔中均不匹配的原子對象，為避免項目管理人員遺漏所無法生成的原子對象，可以采用如下方式:當(dāng)確定所述原子對象的標(biāo)識不匹配或所述原子對象的版本不匹配時，輸出錯誤提示信息，提示錯誤原因。項目管理人員根據(jù)提示信息，即可采用相應(yīng)的措施，例如，通過人工編寫補(bǔ)充所述無法生成的原子對象對應(yīng)的原子文檔內(nèi)容，或者修改版本錯誤的原子對象的原子文檔內(nèi)容。
[0037]從本實施例可以看出，針對需要生成的項目對象的軟件項目文檔,通過獲取滿足所述項目需求的已存在的項目對象的原子對象的標(biāo)識信息，查找與所述原子對象的標(biāo)識信息匹配的項目文檔庫，將所述匹配的項目文檔庫中的原子文檔內(nèi)容進(jìn)行復(fù)制并粘貼到所獲取的項目文檔模板中的對應(yīng)位置，即可生成所需要的所述項目對象的軟件項目文檔，由于所述方法可以充分復(fù)用或繼承現(xiàn)有項目的項目文檔，因此可以提高資源利用效率，避免手工編寫導(dǎo)致的人為錯誤及效率低的問題，且整個過程自動生成，因此可以提高軟件項目文檔生成速度，進(jìn)而可以提高軟件開發(fā)效率。
[0038]本發(fā)明實施例還提供了一種軟件項目文檔生成器，參照圖2，項目文檔生成器200包括:獲取單元201、信息提取單元202和生成單元203，其中:
[0039]獲取單元201，用于獲取需要生成的項目對象中的原子對象的標(biāo)識信息和版本信息；
[0040]信息提取單元202，查找與獲取單元201獲取的所述原子對象的標(biāo)識信息和版本信息匹配的項目文檔庫，將所述匹配的項目文檔庫中的原子文檔內(nèi)容進(jìn)行復(fù)制；
[0041]生成單元，用于將所述信息提取單元202所復(fù)制的原子文檔內(nèi)容粘貼到所獲取的項目文檔模板中的對應(yīng)位置。
[0042]通過本實施例的軟件項目文檔生成器利用已有的軟件項目，將已有的軟件項目文檔中的內(nèi)容原子化，建立每個原子對象對應(yīng)的原子文檔內(nèi)容的項目文檔庫，并建立所述原子對象與所述項目文檔庫的映射關(guān)系，針對所需要生成的項目對象，通過獲取需要生成的項目對象中的原子對象的標(biāo)識信息，即可自動匹配相應(yīng)的項目文檔庫并復(fù)制所述項目文檔庫中的原子文檔內(nèi)容并粘貼至所獲取的項目文檔模板中的對應(yīng)位置，即可自動生成軟件項目文檔，因此本實施例中的項目文檔生成器可以充分復(fù)用或繼承現(xiàn)有項目文檔中的內(nèi)容，提高資源利用效率，且利用已有的項目文檔的內(nèi)容，可以提高生成的軟件項目文檔的可靠性，自動生成軟件項目文檔而非手工編寫，也可以避免人為編寫錯誤，且可提高軟件項目文檔的生成效率，進(jìn)而提高軟件開發(fā)效率。
[0043]在具體實施中，還可以對上述軟件項目文檔生成器作進(jìn)一步的擴(kuò)展或優(yōu)化，參照圖2，在上述實施例基礎(chǔ)上，還可以增加信息提示單元204，用于當(dāng)確定所述項目文檔庫中不存在與所述原子對象的標(biāo)識或者版本匹配的原子文檔內(nèi)容后，輸出錯誤提示信息以提示錯誤原因，從而使得項目管理人員可以快速發(fā)現(xiàn)缺失或錯誤的原子文檔內(nèi)容，進(jìn)行補(bǔ)充或修改。
[0044]在具體實施中，上述實施例中的所述原子對象所對應(yīng)的項目文檔庫可以存儲在本地，也可以存儲在網(wǎng)絡(luò)服務(wù)器上。
[0045]本領(lǐng)域普通技術(shù)人員可以理解上述實施例的各種方法中的全部或部分步驟是可以通過程序來指令相關(guān)的硬件來完成，該程序可以存儲于一計算機(jī)可讀存儲介質(zhì)中，存儲介質(zhì)可以包括:ROM、RAM、磁盤或光盤等。
[0046] 雖然本發(fā)明披露如上，但本發(fā)明并非限定于此。任何本領(lǐng)域技術(shù)人員，在不脫離本發(fā)明的精神和范圍內(nèi)，均可作各種更動與修改，因此本發(fā)明的保護(hù)范圍應(yīng)當(dāng)以權(quán)利要求所限定的范圍為準(zhǔn)。
【權(quán)利要求】
1.一種軟件項目文檔生成方法，其特征在于，包括: 獲取需要生成的項目對象中的原子對象的標(biāo)識信息； 查找與所述原子對象的標(biāo)識信息匹配的項目文檔庫，將所述匹配的項目文檔庫中的原子文檔內(nèi)容進(jìn)行復(fù)制； 將所復(fù)制的原子文檔內(nèi)容粘貼到所獲取的項目文檔模板中的對應(yīng)位置。
2.如權(quán)利要求1所述的軟件項目文檔生成方法，其特征在于，還包括:當(dāng)確定所述原子對象的標(biāo)識不匹配或所述原子對象的版本不匹配時，輸出錯誤提示信息，提示錯誤原因。
3.如權(quán)利要求1所述的軟件項目文檔生成方法，其特征在于，所述原子對象的標(biāo)識信息包括:所述原子對象的名稱和所述原子對象的版本信息。
4.如權(quán)利I至3任一項所述的軟件項目文檔生成方法，其特征在于，所述原子對象所對應(yīng)的項目文檔庫存儲在本地。
5.如權(quán)利要求1至3任一項所述的軟件項目文檔生成方法，其特征在于，所述原子對象所對應(yīng)的項目文檔庫存儲在網(wǎng)絡(luò)服務(wù)器上。
6.一種軟件項目文檔生成器，其特征在于，包括: 獲取單元，用于獲取需要生成的項目對象中的原子對象的標(biāo)識信息； 信息提取單元，查找與所述獲取單元獲取的所述原子對象的標(biāo)識信息匹配的項目文檔庫，將所述匹配的項目文檔庫中的原子文檔內(nèi)容進(jìn)行復(fù)制； 生成單元，用于將所述信息提取單元所復(fù)制的原子文檔內(nèi)容粘貼到所獲取的項目文檔模板中的對應(yīng)位置。
7.如權(quán)利要求6所述的軟件項目文檔生成器，其特征在于，還包括:信息提示單元，用于當(dāng)確定所述項目文檔庫中不存在與所述原子對象的標(biāo)識或者版本匹配的原子文檔內(nèi)容后，輸出錯誤提示信息以提示錯誤原因。
8.如權(quán)利要求6所述的軟件項目文檔生成器，其特征在于，所述原子對象的標(biāo)識信息包括:所述原子對象的名稱和所述原子對象的版本信息。
9.如權(quán)利要求6至8任一項所述的軟件項目文檔生成器，其特征在于，所述原子對象所對應(yīng)的項目文檔庫存儲在本地。
10.如權(quán)利要求6至8任一項所述的軟件項目文檔生成器，其特征在于，所述原子對象所對應(yīng)的項目文檔庫存儲在網(wǎng)絡(luò)服務(wù)器上。
【文檔編號】G06F17/21GK104424159SQ201310398609
【公開日】2015年3月18日 申請日期:2013年9月4日 優(yōu)先權(quán)日:2013年9月4日
【發(fā)明者】呂晨俊, 柏志斌, 王欣一, 王元彪 申請人:上海復(fù)旦微電子集團(tuán)股份有限公司