為.NET調整你的文件工作方案

2019-11-17 04:39:38

字體：大中小

來源：轉載

供稿：網友

　　在你的開發團隊轉移向基于Microsoft .NET的項目的同時，針對你的最終用戶和開發人員的文檔工作方案也應該隨之跟進。你目前的文檔工作方案只是一個出發點，.NET的引入意味著你的技術作者和文檔化工作必須得到調整。

　　文檔工作方案就像是一個項目的計劃和/或是隨著一個軟件產品的推出而被開發技術文檔的標準要求。它包括針對文檔結構，格式，進度安排和交付方式等內容的指導方針。　　Microsoft.NET架構，用戶文檔和在線幫助

　　Microsoft.NET架構并沒有為用戶文檔指定任何特定的幫助文檔格式。不過，對于在線幫助解決方案，微軟的Html Help格式成為被業界普遍接受的標準。　　向"DocumentationPlan.NET"轉移

　　DocumentationPlan.NET并不是一個實際存在的產品，我提出這個名字的意思是強調你的文檔將不得不升級至.NET，就像微軟的編程語言已經升級至.NET環境之中一樣。屬于微軟開發人員項目的軟件編制公司需要同時為程序員和技術作者進行技能組的更新，從而使他們可以開發基于.NET的應用軟件。　　要滿足.NET的額外的需要，你的文檔工作方案應該加入以下一些元素：　　移動用戶所需要的文檔，其中包括文本和圖形

　　在各種不同的平臺之間可以訪問的在線幫助格式，其中包括傳統PC的Web瀏覽器，PDA，可訪問Web的移動電話和其他設備。

　　將打印文檔轉為在線格式的工具

　　在線幫助是一項真正的投資，但有時卻經常被一些軟件開發公司所忽視。Microsoft .NET中具有的機動性元素意味著，在用戶通過他們的PDA或其他移動設備訪問應用軟件時不會再同時攜帶著打印文檔。Microsoft .NET關注于平臺的交叉和機動性，這給文檔工作方案帶來了很大的影響，因為交叉平臺的兼容性和機動性對于很多的開發公司組織來說仍然是一個全新的課題。　　在技術作者的郵件列表中或是技術寫作專家的最新著作中，你是無法找到那些客戶和使用者的額外需要的。你的最終用戶將會給出這些需要，尤其是對于那些第一次向移動計算領域進行轉移的公司組織來說。PDA和能夠訪問Web的電話也許已經成為那些先行者的標準工具，而一些非專業用戶則可能需要通過一個移動設備來訪問基于.NET的應用軟件。　　這樣的結果是，以下的人員就需要進行一些交叉功能性的工作：　　產品經理和/或商業分析人員，他們的工作就是滿足用戶對基于.NET的產品的要求，對用戶的需要進行洞察，提供文檔化工作和培訓等內容。

　　技術作者和分析人員，他們通過一個媒介使用戶文檔在線滿足用戶的訪問需要

　　QA人員，他們通過用戶訪問應用軟件時所使用的各種不同的設備對在線幫助進行測試。
　　
　　新型交叉平臺式幫助文檔開發工具
　
　　就像程序員一樣，技術作者也可以習慣于使用他們的工具，但是向.NET的轉移通常需要有新型文檔工具和方法的引入。通過多種平臺對在線幫助進行訪問的需要逐漸增加，這對現有的文檔工作方案將造成最大的影響。　　Web基于服務的本質意味著在線幫助是為用戶提供協助和培訓的最佳平臺。對于.NET應用軟件來說，在線幫助可以通過下面的方法實現：　　基于服務器的HTML或基于Web的幫助：這樣的服務器端文檔可以是自定制的解決方案，也或者是利用eHelp的RoboHelp EnterPRise這樣的工具所開發的，RoboHelp Enterprise以RoboHelp為基礎，使你可以開發基于服務器的和基于應用軟件的在線幫助解決方案。

　　應用軟件自身所提供的HTML幫助：目前已經有各種不同的工具可以使用，你的公司中也許就有一些。

　　Web幫助：來自于應用軟件或是服務器端。

　　加入xml和 asp.net

　　假如你的文檔工作方案中不包括XML和ASP.NET，你的文檔就需要進行擴展以加入這些內容。對于應用軟件的最終用戶來說，對XML和ASP.NET的使用也許是透明的，但你的軟件開發生存周期和結構性文檔也要考慮到這個問題。　　這可以通過多種途徑實現，其中包括：　　將應用軟件XML DTD文檔化。

　　將ASP.NET代碼文檔化，其中包括一般性項目信息，COM對象和構成ASP.NET的其他元素。有一些自動化的文檔工具可以完成這樣的工作，例如Living Doc。

　　移動用戶

　　在PDA的使用逐漸流行起來的同時，也許有一些技術作者和分析人員還不是很熟悉PDA的環境。此外，移動電話的功能不斷增加，使他們都能夠對Web進行訪問。　　假如你的文檔化工作還擴展到了用戶培訓這一方面，那么你就要提供課堂和在線培訓以滿足人們的需要。有一些工具，例如來自eHelp的RoboDemo，他們可以讓你產生運行在基于PDA的Pocket PC之上的介紹和教程，這些內容同時也可以在Web中進行訪問。　　接受挑戰

　　要調整文檔工作方案以滿足.NET環境的需要，你就要對用戶文檔進行一些改動，采取策略來適應被Microsoft .NET和用戶社區所支持的多種平臺。進入討論組討論。

上一篇：公平理論在項目管理中的作用

下一篇：.Net中適配器、橋接與外觀三模式的關系