在你的開發(fā)團(tuán)隊(duì)轉(zhuǎn)移向基于Microsoft .NET的項(xiàng)目的同時(shí),針對(duì)你的終用戶和開發(fā)人員的文檔工作方案也應(yīng)該隨之跟進(jìn)。你目前的文檔工作方案只是一個(gè)出發(fā)點(diǎn),.NET的引入意味著你的技術(shù)作者和文檔化工作必須得到調(diào)整。
文檔工作方案像是一個(gè)項(xiàng)目的計(jì)劃和/或是隨著一個(gè)軟件產(chǎn)品的推出而被開發(fā)技術(shù)文檔的標(biāo)準(zhǔn)要求。它包括針對(duì)文檔結(jié)構(gòu),格式,進(jìn)度安排和交付方式等內(nèi)容的指導(dǎo)方針。
Microsoft.NET架構(gòu),用戶文檔和在線幫助
Microsoft.NET架構(gòu)并沒(méi)有為用戶文檔指定任何特定的幫助文檔格式。不過(guò),對(duì)于在線幫助解決方案,微軟的HTML Help格式成為被業(yè)界普遍接受的標(biāo)準(zhǔn)。
向"DocumentationPlan.NET"轉(zhuǎn)移
DocumentationPlan.NET并不是一個(gè)實(shí)際存在的產(chǎn)品,我提出這個(gè)名字的意思是強(qiáng)調(diào)你的文檔將不得不升級(jí)至.NET,像微軟的編程語(yǔ)言已經(jīng)升級(jí)至.NET環(huán)境之中一樣。屬于微軟開發(fā)人員項(xiàng)目的軟件編制公司需要同時(shí)為程序員和技術(shù)作者進(jìn)行技能組的更新,從而使他們可以開發(fā)基于.NET的應(yīng)用軟件。
要滿足.NET的額外的需要,你的文檔工作方案應(yīng)該加入以下一些元素:
移動(dòng)用戶所需要的文檔,其中包括文本和圖形
在各種不同的平臺(tái)之間可以訪問(wèn)的在線幫助格式,其中包括傳統(tǒng)PC的Web瀏覽器,PDA,可訪問(wèn)Web的移動(dòng)電話和其他設(shè)備
將打印文檔轉(zhuǎn)為在線格式的工具
在線幫助是一項(xiàng)真正的投資,但有時(shí)卻經(jīng)常被一些軟件開發(fā)公司所忽視。Microsoft .NET中具有的機(jī)動(dòng)性元素意味著,在用戶通過(guò)他們的PDA或其他移動(dòng)設(shè)備訪問(wèn)應(yīng)用軟件時(shí)不會(huì)再同時(shí)攜帶著打印文檔。Microsoft .NET關(guān)注于平臺(tái)的交叉和機(jī)動(dòng)性,這給文檔工作方案帶來(lái)了很大的影響,因?yàn)榻徊嫫脚_(tái)的兼容性和機(jī)動(dòng)性對(duì)于很多的開發(fā)公司組織來(lái)說(shuō)仍然是一個(gè)全新的課題。
在技術(shù)作者的郵件列表中或是技術(shù)寫作專家的新著作中,你是無(wú)法找到那些客戶和使用者的額外需要的。你的終用戶將會(huì)給出這些需要,尤其是對(duì)于那些第一次向移動(dòng)計(jì)算領(lǐng)域進(jìn)行轉(zhuǎn)移的公司組織來(lái)說(shuō)。PDA和能夠訪問(wèn)Web的電話也許已經(jīng)成為那些先行者的標(biāo)準(zhǔn)工具,而一些非專業(yè)用戶則可能需要通過(guò)一個(gè)移動(dòng)設(shè)備來(lái)訪問(wèn)基于.NET的應(yīng)用軟件。
這樣的結(jié)果是,以下的人員需要進(jìn)行一些交叉功能性的工作:
產(chǎn)品經(jīng)理和/或商業(yè)分析人員,他們的工作是滿足用戶對(duì)基于.NET的產(chǎn)品的要求,對(duì)用戶的需要進(jìn)行洞察,提供文檔化工作和培訓(xùn)等內(nèi)容
技術(shù)作者和分析人員,他們通過(guò)一個(gè)媒介使用戶文檔在線滿足用戶的訪問(wèn)需要
QA人員,他們通過(guò)用戶訪問(wèn)應(yīng)用軟件時(shí)所使用的各種不同的設(shè)備對(duì)在線幫助進(jìn)行測(cè)試
新型交叉平臺(tái)式幫助文檔開發(fā)工具
像程序員一樣,技術(shù)作者也可以習(xí)慣于使用他們的工具,但是向.NET的轉(zhuǎn)移通常需要有新型文檔工具和方法的引入。通過(guò)多種平臺(tái)對(duì)在線幫助進(jìn)行訪問(wèn)的需要逐漸增加,這對(duì)現(xiàn)有的文檔工作方案將造成大的影響。
Web基于服務(wù)的本質(zhì)意味著在線幫助是為用戶提供協(xié)助和培訓(xùn)的佳平臺(tái)。對(duì)于.NET應(yīng)用軟件來(lái)說(shuō),在線幫助可以通過(guò)下面的方法實(shí)現(xiàn):
基于服務(wù)器的HTML或基于Web的幫助:這樣的服務(wù)器端文檔可以是自定制的解決方案,也或者是利用eHelp的RoboHelp Enterprise這樣的工具所開發(fā)的,RoboHelp Enterprise以RoboHelp為基礎(chǔ),使你可以開發(fā)基于服務(wù)器的和基于應(yīng)用軟件的在線幫助解決方案。
應(yīng)用軟件自身所提供的HTML幫助:目前已經(jīng)有各種不同的工具可以使用,你的公司中也許有一些。
Web幫助:來(lái)自于應(yīng)用軟件或是服務(wù)器端。
加入XML和ASP.NET
如果你的文檔工作方案中不包括XML和ASP.NET,你的文檔需要進(jìn)行擴(kuò)展以加入這些內(nèi)容。對(duì)于應(yīng)用軟件的終用戶來(lái)說(shuō),對(duì)XML和ASP.NET的使用也許是透明的,但你的軟件開發(fā)生存周期和結(jié)構(gòu)性文檔也要考慮到這個(gè)問(wèn)題。
這可以通過(guò)多種途徑實(shí)現(xiàn),其中包括:
將應(yīng)用軟件XML DTD文檔化。
將ASP.NET代碼文檔化,其中包括一般性項(xiàng)目信息,COM對(duì)象和構(gòu)成ASP.NET的其他元素。有一些自動(dòng)化的文檔工具可以完成這樣的工作,例如Living Doc。
移動(dòng)用戶
在PDA的使用逐漸流行起來(lái)的同時(shí),也許有一些技術(shù)作者和分析人員還不是很熟悉PDA的環(huán)境。此外,移動(dòng)電話的功能不斷增加,使他們都能夠?qū)eb進(jìn)行訪問(wèn)。
如果你的文檔化工作還擴(kuò)展到了用戶培訓(xùn)這一方面,那么你要提供課堂和在線培訓(xùn)以滿足人們的需要。有一些工具,例如來(lái)自eHelp的RoboDemo,他們可以讓你產(chǎn)生運(yùn)行在基于PDA的Pocket PC之上的介紹和教程,這些內(nèi)容同時(shí)也可以在Web中進(jìn)行訪問(wèn)。
接受挑戰(zhàn)
要調(diào)整文檔工作方案以滿足.NET環(huán)境的需要,你要對(duì)用戶文檔進(jìn)行一些改動(dòng),采取策略來(lái)適應(yīng)被Microsoft .NET和用戶社區(qū)所支持的多種平臺(tái)。