所以你 ’ re 負責管理檔的專案。你知道誰是你的聽眾，他們所 ’ 再試圖實現、 產品如何使他們能夠實現它，和觀眾需要的説明。現在它 ’ s 時間規格出你的意圖。
注意： 這是第二次在一系列的三篇文章概述了一個良好的使用者文檔過程的關鍵要素。（要閱讀本系列中的第一和第三的文章，請轉到 HTTP://www.divinewrite.com/docoprocess1.htm 和 HTTP://www.divinewrite.com/docoprocess3.htm。）
說明你的目標
一般講，你的目標聲明應表明您希望創建一套會滿足觀眾要求的文檔產品。具體來說，您 ’ 著大量的次級目標。（提示： 它可能會説明，請記住您在此處設置的目標將需要用來衡量你的產品通過您自己的內部測試和評價使用者研究成功。）這種次級目標可能包括：
• 便於使用
• 可訪問性
• 樂於助人
• 精度
• 關聯
• 全面性
• 遵守風格指引
• 自動校正拼寫和標點
寫入您的概念規格
您的目標設置，就可以開始考慮什麼你 ’ 再去製造。第一步是創建一些概念規格。概念規格簡單地說，是的你很高級別概述 ’ 重新提出生產。例如，您的線上說明的概念規範可能狀態你會產生一種允許使用者訪問的資訊，使用目錄、 索引和查找產品。它可能還建議一些可能的 GUI 功能，這些元素，但它不會定下的要求 ；公正的可能性。你手冊的概念規範可能他們將以專業的狀態來看，將包含許多專業繪製的圖片，將會有足夠的白色空間，將時尚，將分為章節以匹配的線上說明等面向任務性質。
一般情況下，該產品你 ’ 再提出可在多種不同的方式推行。你應該寫一個或多個概念的 spec(s)：
· 哪些元件文檔套件將包括線上說明、 印刷的手冊、 教程、 概述等） — —"文檔產品概念規格"
• 您的文檔將包含的資訊類型 （例如，結構的目錄中，是你打算遵循極簡主義做法？） — —"文檔內容的概念規格"
· 你的文檔套件 （例如，它是如何工作和如何，觀眾將與其進行交互） — — 的功能和使用者介面"線上說明使用者介面的概念規格"、"列印文檔使用者介面的概念規格"等。
• 傳遞方法 （您將如何交付給使用者的説明和如何會對它進行更新）
• 文檔會產生什麼語言
設計一些可能的實現
現在，您 ’ ve 什麼你決定大約 ’ d 像要生產，您可以設計一些可能的實現。您的設計將會很高的水準，他們可能不實際工作 （他們實際上可能只是紙上原型）。
最考慮其它已經敲定通過你的使用者需求研究，這些實現應只不同的結果：
• 他們背後的技術
• 使用工具來創建它們
• 總體外觀和效果
您需要對這種事情，以便確定什麼是實際上可能的、 成功的、 有效的、 等盡可能多地學習。你應該意識到當前的趨勢、 文學、 白皮書等。此資訊可以從多種來源獲得。一些好的地方，以啟動包括：
• 清單伺服器
· 會議
• 書籍
· 其他出版物
· 其他作家
· 其他產品
進行可用性測試您的原型
為決策者和觀眾樣品模型 （原型） 您的設計。這允許您選擇的每種設計的最佳功能 （和為他們確定的優先事項）。選擇一種設計 （或合併多個設計） 你認為最好滿足使用者的需求。此過程可能會反覆運算。在這一階段結束時，你應該知道足夠的細節究竟什麼你 ’ 將會生產 (包括什麼説明平臺和工具你 ’ 將一直使用）。
提示： 可能研究方法的詳細資訊，看看管理您的文檔專案由 Hackos （1994 年） 尤其是 pp.446-447、 使用者和介面設計的 Hackos & 蘿蔔乾任務分析 （1998 年），社會行銷： 新勢在必行的 Manoff （1985 年），由公共衛生設計定性研究馬紹爾 & Rossman （1995 年），第二版和 “ 進行焦點小組 – 首次使用者指南 ”在行銷情報和規劃，由泰納 － 德雷頓 (1988 年)。
寫你要求規範
要求規範詳細說明究竟什麼必須最終你。這些指標應盡可能的特性和功能的文檔產品包含盡可能多的詳細資訊 （怎麼不你 ’ 我會去建設它）。
要求規格基本上都是你的概念規格的演變。一旦你對你的要求規格開始工作，實際上被凍結的概念規格。你應該寫一個或多個概念的 spec(s)：
· 哪些元件文檔套件將包括線上說明、 印刷的手冊、 教程、 概述等） — —"文檔產品要求規格"
• 您的文檔將包含的資訊類型 （例如，結構的目錄中，是你打算遵循極簡主義做法？） — —"文檔內容要求規格"
· 你的文檔套件 （例如，它是如何工作和如何，觀眾將與其進行交互） — — 的功能和使用者介面"線上說明使用者介面的要求規範"、"列印文檔使用者介面的要求規範"等。
• 傳遞方法 （您將如何交付給使用者的説明和如何會對它進行更新）
• 文檔會產生什麼語言
估計專案工期和資源
一旦您 ’ ve 完成要求規範階段，你應該知道不夠準確地估計，其餘的專案的持續時間和資源要求。您還應該更新 “ 檔的專案計劃 ” 具有此資訊的文檔。
估計總是很困難的過程，也有 ’ s 真的沒有任何萬全的方法獲取正確。大多是它取決於工作和你的經驗。然而，以下是一些指導原則，可能會説明您。
如果您有記錄從以前的專案，您可能只是無法估計基於這些專案工期。您應該嘗試比較舊的主體材料，具有新的以確保舊時代的主題將適用于新的專案。管理您的文檔專案 (1994 年) 的 p.174，Hackos 比較複雜的各種文檔專案提供一些潛在的有用的指導方針。
如果，另一方面，專案是全新的你就沒有記錄可供使用作為指南 （除非你在過去成功了一個類似的專案）。在此情況下，專案估計會很難。
一個可能的方法，估計是：
1.編譯的任務的清單，並記錄有多少您的清單中。
2.編譯的概念，必須記錄在案，並記錄有多少您的清單中的清單。
3.從您的工作清單，請選擇具有代表性和相同的細微性 （的複雜性、 預期的長度、 狀態有關的發展，等等），其餘的 10 （例如，您可以編寫單個主題為每個）。
4.從概念的清單中，選擇有代表性的其餘部分，以及相同的細微性的 3 （例如，您可以編寫單個主題為每個）。
5.估計每項專題的頁數。
6.作為試驗，確保您的追蹤記錄這些任務和概念：
· 完成每個主題所需的總時間。
· 這一次，是由於產品更改或優柔寡斷的部分。
• 每個主題的頁數。
• 您開始意識到由於文檔的額外，意外，但有必要，主題的數目。單獨記錄的任務和概念性主題的號碼。
提示： 充分利用您的試用 doco。即使你 ’ ve 選擇通過設計原型設計，您可以使用您的文檔示例來測試您的文檔的方法的可用性。通過提交到觀眾示例的示例，您可以確定是否您 ’ 正在朝著正確的方向與您 doco （即是否你已解釋和正確地實施您的使用者研究結果） 的標題。
7.確定每頁為任務和概念性主題的平均時間。
8.將這個平均應用於專案中的主題的其餘部分。(主題通常寫在專案的早期長由於缺乏資訊和更多的技術問題。這意味著主題編寫過程的後期可能會計算的平均低於在這裡。不過，這會通常會抵消由產品的更改將承擔專案的生命週期中的額外時間。）
9.估計每個學科領域基於每個主題的平均時間的時間。
10.估計可能會在其餘的專案的過程中所需的額外的、 意外的情況下，主題的數目。
11.允許進行培訓、 工作實踐維護、 假期、 病假、 會議、 可用性測試、 生產 （約 6 個星期周轉時間印刷 1000年頁手冊，其中包括校對）、 評估和評價測試。每個元素將該專案的性質而異，他們往往會採取的實際寫入遠較短的時間。這就是為什麼它們寫作不提供具體的指導方針。
多長時間，你確實需要做，那麼，有多少作家出你 ’ 將需要這樣做在這段時間。制訂使用 Microsoft Project，找出有用的里程碑和專案期限類似的專案日程。您的里程碑的一些可能包括：
• 原型測試完成
• 工作 Pracs 寫
· 設計規格編寫
• 初稿完成
· 第二稿完成
· 第二稿完成當地語系化
· 最後草案完成
• 完整的當地語系化
• 釋放文檔準備就緒
• 生產完成
• 專案鑒定完畢
• 釋囚可用性測試完成
這是重要的是要注意你會有這點之前, 的里程碑，但因為它們發生在正式的調度階段之前，他們愛 ’ t 需要包含在本附表中。
寫工作 Pracs & 設計規格
使用者研究，以及 pracs 和設計規格也許是最簡單的專案元素，以忽略，尤其是對於一個小團隊的工作。然而，即使在小的團隊，將有助於保持兩個。
工作 pracs 是正在進行的事情，會影響團隊的日常工作環境 （例如，如何使用您的文檔的工具，如何釋放你的説明，風格指南，等等。）。設計規格用於記錄一次性之類的實際計畫我們如何去一下這件事。這將包括此類資訊作為什麼工具我們 ’ 將會使用，什麼每個會做，和如何的力學這一切貫穿在一起。例如，如何 VSS 專案將工作，一切都應如何管理、 多使用者的問題，如何將當地語系化，等它。
未完待續 … 編寫您的使用者文檔的資訊，請參閱本文 （HTTP://www.divinewrite.com/docoprocess3.htm） 的第 3 部分。
No comments:
Post a Comment