所以您瞭解您的使用者文檔專案和你 specced 出來。現在你已經準備寫。下面是一些提示可以説明您在您的路上。這篇文章並不是有關實際編寫本身 ；這是一起寫的東西。(寫作的線上說明的資訊，請參閱 HTTP://www.divinewrite.com/helpfulhelp.htm。）
注意： 這是最後一篇文章中一系列的三個概述了一個良好的使用者文檔過程的關鍵要素。（要閱讀本系列中的第一和第二次的文章，請轉到 HTTP://www.divinewrite.com/docoprocess1.htm 和 HTTP://www.divinewrite.com/docoprocess2.htm。）
索引
應定義的索引關鍵字，而正在寫入該主題。在這個時候，標的物在作者的心目中，顯然，他們是非常熟悉的所有複雜的細節。索引在寫作階段也意味著你的關鍵字審查作為草案過程的一部分。
一些創作工具真的不方便這種特別好 （例如，一些不允許多個作者訪問索引所需的檔），但至少關鍵字應列在每個草案的末尾。(根據創作工具中，這可能實際上是便於檢閱者，無論如何。）提示： 編制索引的進一步資訊，請參閱藝術的索引 （1994 年） 由博努拉。
使用者文檔評論
要確保您的使用者文檔從技術上講是正確的、 可讀的您需要獲取它由智慧選擇的人進行審查。對於軟體的專案，您審查清單應包括主題專家 （一般程式師）、 軟體設計師、 也許專案經理和另一位作家。審評的要求將會隨每個草案，所以您的檢閱者，並審查程式應記錄在您的工作 pracs。
測試您的使用者文檔
可以在多個層面進行測試：
• 每個作家應按照以下它要使用的產品測試他們自己的使用者文檔。但是請記住，這種測試不是功能非常強大，因為有一種傾向，作家們可以按照說明進行操作，他們認為他們已經寫了，不像他們實際上已經寫給他們。
· 第二層是進行測試，以執行其他作家 ... ... 作為同儕審查的一部分。
· 第三級是質檢部門做正式的測試上的使用者文檔。這種類型的測試並不經常發生，但它是很好，試圖讓它發生。
· 第四級是/應作為測試的一部分進行 （請參閱管理您的文檔專案的 Hackos （1994 年），pp.452-453)。
無論您使用什麼級別的測試，它應旨在確保記錄的任務對該產品，並且任何線上說明功能正確。它需要通過測試的使用者文檔，以滿足您在專案的早期階段中指定的目標。
當即您的使用者文檔
雖然當地語系化，往往被視為一種 post-writing 的活動，最好把它作為寫作階段的一部分。確切的時間可能不同專案到專案，但一個良好經驗法則是讓翻譯人員，工作上第二個草稿 （但只有當你不在期望對草案的許多變化）。提示： 大多數翻譯員可能更願意工作一塊龐大的使用者文檔，而不是單個主題發送給他們一頓飯，所以你應該等待直到你有什麼令人尊敬的大小，以發送他們 — — 或許整個主題區域，而不是單個主題。
與當地語系化，正在執行一種平衡的行為。如果您發送的使用者文檔翻譯人員太快，你會花很多錢對翻譯所做更改。如果您要發送它太晚，不會釋放該產品的及時準備好。
管理變革
它是重要你儘量減少到產品和/或發展計畫的更改的影響。要執行此操作，您需要開發一種技術的：
1.標識更改
2.在時間和/或資源估計影響 ＊
3.通知專案經理
＊ 你可以使用相同的估算技術作為你較早時在專案中使用。
跟蹤寫作進度
它是重要的是要注意寫作階段並不只是關於寫作。如果您跟蹤您的進度，一路走來的每一步，您將能看看是否你將會滿足您的里程碑和最後期限，你還能夠使用此專案作為一種學習經歷 ... ... 來更好地規劃下一次。（您應該確保專案的所有記錄都都方便日常維護和未來的專案引用。）
您應該跟蹤執行此過程，以及每個草案階段、 審查時間、 總周轉時間等所述的每一步所需的時間。
進行週期性團隊會議
為了保持寫作進度的通知的所有團隊成員，您應進行定期團隊會議。這些會議應該是一個論壇，看看你跟蹤的度量和討論完成目前正在進行的各項主題的估計的百分比。如果完成的估計的百分比低於應賦予它已經花費的時間，然後你可以行動起來。這些會議允許您標識中寫作進度。
寫作進度報告
您的管理還需要隨時通報的專案的狀態。您應編寫定期進度報告，概述：
• 專案所在的
• 你做了什麼，過去一個月
• 您計畫下個月做些什麼
• 任何問題你已經遇到
生產管理
"生產"的含義取決於您正在處理何種文檔資料和觀眾是誰。它可以包含諸如：
• 印刷
• 綁定
• 產品生成 （當説明編譯成產品）
雖然生產階段通常只需要管理，您仍然需要動用公平一點時間校對和與生產人員聯絡。
評估專案
評估階段的目的是要考慮：
· 做專案按計劃去嗎？
· 為什麼呢？/ 為什麼不呢？
• 如何各個團隊成員的整體專案作出了貢獻。
· 專案經理的表現如何。
• 文檔是否實現其目標。
您跟蹤衡量標準將用場在這個階段 ；如果專案進展中存在的任何缺陷，他們應該去某種程度上的有助於識別它們。您也可以使用在管理您的文檔專案 Hackos (1994 年)，由 Hackos 所提供的示例評價報告 pp.514 518。
您的文檔是成功嗎？
現在，您已經編寫併發布文檔，您需要確定是否達到你的目標。準確地執行此操作的唯一方法是進行進一步的使用者研究。
提示： 研究方法的詳細資訊，看一看管理由 Hackos （1994 年）、 使用者和任務分析您的文檔專案由 Hackos & 蘿蔔乾介面設計 （1998 年），社會行銷： 新勢在必行的 Manoff （1985 年），由公共衛生設計定性研究由馬歇爾 & Rossman （1995 年） 和"進行焦點小組 — — 首次者指引 》，在行銷情報和規劃泰納 & 德雷頓第二版 (1988 年)。
然後就行了 ！請記住，此過程是一個 '理想' 的過程。位，適合您和您的專案，並離開不要的位。
祝你好運！
No comments:
Post a Comment