型計算機(jī)、平板計算機(jī)、筆記本計算機(jī)、個人計算機(jī)(PC)、臺式計算機(jī)、個人數(shù)字助理(PDA)、智能電話、或能夠經(jīng)由網(wǎng)絡(luò)104與客戶端計算機(jī)106、108和110通信的任何可編程電子設(shè)備。在某些實(shí)施例中,服務(wù)器計算機(jī)102表示使用集群計算機(jī)和組件的計算機(jī)系統(tǒng),當(dāng)通過網(wǎng)絡(luò)104被訪問時所述集群計算機(jī)和組件充當(dāng)單個無縫資源池,如常見于具有云計算應(yīng)用的數(shù)據(jù)中心中的那樣。通常,服務(wù)器計算機(jī)102代表能夠執(zhí)行機(jī)器可讀程序指令并經(jīng)由網(wǎng)絡(luò)與其他計算設(shè)備通信的任何可編程電子設(shè)備或可編程電子設(shè)備的組合。參考圖4更詳細(xì)地描述服務(wù)器計算機(jī)102的示例性組件。
[0022]在本發(fā)明的各種實(shí)施例中,客戶端計算機(jī)106、108和110可以各自分別是膝上型計算機(jī)、平板計算機(jī)、應(yīng)用服務(wù)器、筆記本計算機(jī)、個人計算機(jī)(PC)、臺式計算機(jī)、個人數(shù)字助理(PDA)、智能電話、或者能夠經(jīng)由網(wǎng)絡(luò)104與服務(wù)器計算機(jī)102通信的可編程電子設(shè)備。
[0023]網(wǎng)絡(luò)104可以包括例如局域網(wǎng)(LAN)、諸如因特網(wǎng)的廣域網(wǎng)(WAN)或二者的組合,并且可以包括有線、無線和/或光纖連接。通常,網(wǎng)絡(luò)104可以是連接和協(xié)議的任意組合,其可以支持在服務(wù)器計算機(jī)102與客戶端計算機(jī)106、108和110之間的通信。
[0024]在此實(shí)施例中,客戶端計算機(jī)106、108和110每一個分別包括客戶端應(yīng)用程序200的實(shí)例,其在各自的客戶端計算機(jī)上本地地執(zhí)行并且能夠連接到服務(wù)器計算機(jī)102上的軟件產(chǎn)品112。在所述的環(huán)境中,客戶端應(yīng)用程序200使用用戶接口 118接收用戶輸入,并且向用戶輸出響應(yīng)。用戶接口 118可以利用網(wǎng)頁應(yīng)用、命令行處理器應(yīng)用或者任何其他圖形用戶接口(GUI)??蛻舳藨?yīng)用程序200通過網(wǎng)絡(luò)104向服務(wù)器計算機(jī)102發(fā)送信息或者從眾接收信息??蛻舳藨?yīng)用程序200連接到軟件產(chǎn)品112以便執(zhí)行分布式數(shù)據(jù)處理環(huán)境100內(nèi)部的一些功能或任務(wù)。客戶端應(yīng)用程序200可以是能夠連接到軟件產(chǎn)品112并請求軟件產(chǎn)品112執(zhí)行一些任務(wù)的任何程序。客戶端應(yīng)用程序200可以由軟件產(chǎn)品112的廠家或開發(fā)者創(chuàng)建的用于使用在服務(wù)器-客戶端環(huán)境中的相關(guān)聯(lián)的客戶端應(yīng)用。
[0025]服務(wù)器計算機(jī)102包括用戶接口120、軟件產(chǎn)品112、幫助系統(tǒng)114和帶注釋的幫助文件116。用戶接口 120可以利用網(wǎng)頁、命令行處理器或者任何其他GUI來連接到軟件產(chǎn)品112。在所描述的環(huán)境中,軟件產(chǎn)品112使用用戶接口 120來接收用戶輸入,并且向諸如系統(tǒng)管理員之類的用戶輸出響應(yīng)。通過網(wǎng)絡(luò)104,服務(wù)器計算機(jī)102可以從運(yùn)行于客服端計算機(jī)(即,客戶端計算機(jī)106、108和110)上的客戶端應(yīng)用程序200接收對于幫助內(nèi)容的請求。另夕卜,對于幫助內(nèi)容的請求可以來自于運(yùn)行于服務(wù)器計算機(jī)102上的軟件產(chǎn)品112內(nèi)。軟件產(chǎn)品112將對于幫助內(nèi)容的請求向幫助系統(tǒng)114傳遞。幫助系統(tǒng)114通過如下一系列操作來處理該請求:識別駐留在帶注釋的幫助文件116中的相應(yīng)的幫助文檔,用來自軟件產(chǎn)品112的信息或環(huán)境配置文件定制被識別的帶標(biāo)注的幫助文件,并將與該請求相關(guān)聯(lián)的定制的幫助內(nèi)容發(fā)回源請求者,即客戶端應(yīng)用程序200或者軟件產(chǎn)品112。
[0026]在圖1的示例實(shí)施例中,幫助系統(tǒng)114和帶注釋的幫助文件116位于具有軟件產(chǎn)品112的服務(wù)器計算機(jī)102上。在本發(fā)明的另一實(shí)施例中,幫助系統(tǒng)114、帶注釋的幫助文件116和軟件產(chǎn)品112可以位于一個以上的計算機(jī)上,并且每個項目自身可以被劃分成多個部分,并分散在一個以上的計算機(jī)上。在任何配置中,均保持如下內(nèi)容:幫助系統(tǒng)114連接到帶注釋的幫助文件116,并且連接到軟件產(chǎn)品112。幫助系統(tǒng)114可以完全地集成、部分地集成在軟件產(chǎn)品112和客戶端應(yīng)用程序200中或者與它們完全地相分離。幫助系統(tǒng)114可以包括但不限于幫助系統(tǒng)技術(shù),例如Eclipse平臺幫助系統(tǒng),Eclipse信息中心(信息中心)或UNIX?人(手冊)頁。在本發(fā)明的另一實(shí)施例中,幫助系統(tǒng)114可以是在軟件產(chǎn)品112的安裝環(huán)境之外的被遠(yuǎn)程托管的在線網(wǎng)頁應(yīng)用,并且利用可以位于網(wǎng)頁服務(wù)器上或者安裝環(huán)境中的帶注釋的幫助文件116。在圖2中進(jìn)一步描述幫助系統(tǒng)114。
[0027]圖2是描述了根據(jù)本發(fā)明實(shí)施例的定制的上下文敏感的幫助系統(tǒng)(幫助系統(tǒng)114)的操作步驟的流程圖。在優(yōu)選實(shí)施例中,幫助系統(tǒng)114包括指定用環(huán)境特定的值替換帶注釋的幫助文件116內(nèi)的選擇字段的能力。
[0028]幫助系統(tǒng)114接收針對幫助內(nèi)容的請求(步驟202)。運(yùn)行于服務(wù)器計算機(jī)102上的幫助系統(tǒng)114接收來自用戶的針對幫助內(nèi)容的請求。在一個實(shí)施例中,幫助系統(tǒng)114通過網(wǎng)絡(luò)104從運(yùn)行于客戶端計算機(jī)(即客戶端計算機(jī)106、108或110)上的客戶端應(yīng)用程序200接收針對幫助內(nèi)容的請求。客戶端應(yīng)用程序200通過用戶接口 118接收來自用戶的針對幫助內(nèi)容的請求。在另一實(shí)施例中,幫助系統(tǒng)114從運(yùn)行于服務(wù)器計算機(jī)102上的軟件產(chǎn)品112接收針對幫助內(nèi)容的請求。軟件產(chǎn)品通過用戶接口 120接收來自用戶的針對幫助內(nèi)容的請求。在兩種情況中,用戶通過用戶接口輸入針對幫助內(nèi)容的請求。用戶可以初始地點(diǎn)擊幫助按鈕或者選擇幫助菜單項目,以獲得來自幫助系統(tǒng)114的初始幫助屏幕。從初始標(biāo)準(zhǔn)屏幕,用戶可以從內(nèi)容的索引列表或表格中選擇主題或者使用搜索功能搜索主題。在識別到感興趣的主題之前可能要做出多次選擇,鉆取若干層級的主題。每次當(dāng)用戶點(diǎn)擊一個主題的鏈接時,針對幫助內(nèi)容的請求被創(chuàng)建并被發(fā)送到幫助系統(tǒng)。例如,用戶想要配置新的軟件產(chǎn)品以連接到DB2數(shù)據(jù)庫。用戶將啟動幫助系統(tǒng),并且在內(nèi)容的表格中做出如下的選擇:點(diǎn)擊軟件產(chǎn)品名稱,在那個主題內(nèi)點(diǎn)擊主題“配置”,在那個主題內(nèi)點(diǎn)擊主題“配置數(shù)據(jù)庫鏈接”,并且在那個主題內(nèi)點(diǎn)擊主題“連接到DB2數(shù)據(jù)庫”。至此,用戶已經(jīng)找到了感興趣的主題。在每一次點(diǎn)擊上,網(wǎng)頁可以被顯示在內(nèi)容列表的右邊,其可以包含或者可以不包含已經(jīng)被實(shí)際值替換的帶注釋的變量。不是每一個幫助頁面都包含這些變量,但是包含這些變量的幫助頁面在它被顯示給用戶之前將要求用實(shí)際值替換變量。
[0029]在另一實(shí)施例中,軟件產(chǎn)品112響應(yīng)于在執(zhí)行某個任務(wù)時的錯誤而創(chuàng)建針對幫助內(nèi)容的請求,并且繼而將針對幫助內(nèi)容的請求向幫助系統(tǒng)114發(fā)送。例如,在商業(yè)環(huán)境中使用膝上型計算機(jī)的用戶可以使用它們膝上型計算機(jī)上的客戶端應(yīng)用程序200連接到諸如軟件產(chǎn)品112之類的服務(wù)器應(yīng)用,用于請求數(shù)據(jù)存儲的任務(wù)。軟件產(chǎn)品112可能在執(zhí)行數(shù)據(jù)存儲的任務(wù)時寫入硬件設(shè)備的時候出錯。在該錯誤之后,軟件產(chǎn)品112可以創(chuàng)建針對幫助內(nèi)容的請求,所述請求基于該錯誤識別感興趣的主題,例如,來自客戶端計算機(jī)的數(shù)據(jù)存儲的問題。響應(yīng)于一些錯誤代碼,詳述某些錯誤日志的位置的幫助文檔可以被呈現(xiàn),因此客戶可以將日志向外部技術(shù)支持發(fā)送。錯誤日志的位置可以是用實(shí)際環(huán)境值填充的注釋。本技術(shù)領(lǐng)域的普通技術(shù)人員將意識到存在可以接收針對幫助內(nèi)容的請求的其他方式。
[0030]在步驟204中,幫助系統(tǒng)114識別來自帶注釋的幫助文件116的被請求的幫助內(nèi)容。幫助系統(tǒng)114接收包括感興趣主題的針對幫助內(nèi)容的請求。幫助系統(tǒng)114識別來自帶注釋的幫助文件116的被請求的幫助內(nèi)容,以使被識別的帶注釋的幫助文件與針對幫助內(nèi)容的請求中的感興趣主題匹配。在這里使用的“被識別的帶注釋的幫助文件”以單數(shù)的形式被標(biāo)示,但是實(shí)際上可以是形成輸出屏幕的文件的集合。軟件產(chǎn)品112和幫助系統(tǒng)114 二者的產(chǎn)品開發(fā)者準(zhǔn)備帶注釋的幫助文件116。產(chǎn)品開發(fā)者在具有特別注釋的帶注釋的幫助文件116內(nèi)創(chuàng)建多個幫助文檔文件,所述特別注釋標(biāo)示幫助內(nèi)容內(nèi)的變量。這些上下文特定的變量與諸如服務(wù)器名稱和配置根目錄之類的配置和環(huán)境特定的值相關(guān),并且在開發(fā)階段被產(chǎn)品團(tuán)隊所知曉。
[0031]在步驟206中,幫助系統(tǒng)114識別被識別的帶注釋的幫助文件中的一個或多個變量。為了變量掃描來自步驟204的被識別的帶注釋的幫助文件。每個被識別的帶注釋的幫助文件可以保持有一個或多個變量,并且可以包括單個變量的多個實(shí)例。變量對應(yīng)于環(huán)境特定的值,包括但不限于:硬盤路徑、服務(wù)器名稱或者端口配置。來自這些變量的值在軟件產(chǎn)品112的安裝期間被定義。
[0032]在步驟208中,幫助系統(tǒng)114從被識別的帶注釋的幫助文件中取回用于一個或多個變量的每一個的值。幫助系統(tǒng)114與軟件產(chǎn)品112進(jìn)行接口以取回步驟206中識別的一個或多個變量的實(shí)