技術寫作的恐懼
IntroductionSometimes可能超出預算的公司或個人僱用一名專業作家，以解決他們的技術文檔。雖然在一個理想的世界上所有的技術文件必須出示 由訓練有素的專家，遺憾的是我們不是生活在一個理想的。以同樣的方式，很多人會嘗試修復自己的家電，很多人會嘗試寫高質量的技術文件。 正如擺弄烤麵包機可能會導致觸電，試圖寫入技術文件從頭開始，恕不意見，最終導致失敗。作為一個粗略的經驗法則，應始終尋求 聘請專家，但如果你因為種種原因不能和你是窮人不幸的是，不得不文件強加給他們的職責，不要絕望。這份簡短的指南概述一些核心技巧，你會 需要把你的寫作，技術公約意識到，軟件包可以考慮，明確的事情，就是避免。希望即使你有沒有寫過的一句話你生活中任何事情 模糊技術你將有至少一個更廣泛的技術寫作entails.What什麼是技術寫作？技術寫作毫不奇怪的是，指的是書面的技術。雖然 這似乎是一個荒謬的定義，這是一個重要的記憶。作者太多的技術錯誤，使創建文檔，要么過於技術性，或太'文學'。一個很好的技術 作者應該能夠調整兩者之間的平衡，以滿足最終用戶的文檔。技術寫作是很多新鮮的空氣一樣，普遍，但幾乎看不見。在有線世界怪異 我們所處的技術寫作是無處不在。軟件手冊，用戶指南家電產品，教學傳單，電子郵件，信函，報告，技術新聞報導，統計資料和傳記的 電視體育節目都是技術寫作的例子是，人們接觸到每天。如果您曾經試圖程序的時間設置在家庭錄像機，在遙遠的手冊 厭惡的房間，你扔了一塊技術寫作（雖然顯然不是一個很好的！）。太多多次技術文獻是由作家與沒有掌握足夠大的技術，或 技術專家缺乏寫作能力。作為一個潛在的技術作家，你必須小心非常微妙的線在技術上熟悉你的專業領域（š），以及作為一個'好'作家（如 反對'壞'作家誰通常可以找到搶劫老太太，或甜的東西）。技術文件製作通常是兩個不同的用戶群體，即專家級用戶，和天真的用戶。作為一個 技術作家之一，你的第一個任務是挑選出最觀眾你正在寫的，這使我熟練地為：了解你的foeAs舊clichÃÆ'Ã， ©去，每個人的評論家。尤其是這樣 大多數有理智的人的反應時，面臨著技術寫作。正如強調了例子，錄像機以上，技術寫作可以堅不可摧的最終用戶。如果是這樣的話，那是因為 誰寫的文件，並沒有查明其受眾，寫他們的水平。這似乎是一個顯而易見的道理，說的，但其中一個常常被忽視，該用戶的文件的創建， 其實不一定是專家。顯然，如果您要創建一個文件，對某一專業產品為特定的高級用戶組（一個很好的例子是審計軟件的計算機系統 管理員），那麼您將需要撰寫這是一個完全不同的方式，如果你正在創造，技術手冊為大眾市場電腦軟件針對家庭用戶的經驗。其中 你的首要任務必須完成，甚至之前落筆，鍵盤的手指，是確定誰是用戶對你的文件將和建設的文件針對特定目標組（S）。如果 你這個階段的正確，也應避免被拋出你的文件在不同的房間煩惱！規劃perfectionOnce您已經確定了目標市場的文件，您將創建，您需要 開始計劃如何將舉辦文件。這一進程在很大程度上取決於什麼文件正在製作，但你可以按照一些粗略的經驗法則。首先，如果文件支持 特別是詳細的產品（如計算機應用）讓您的骯髒的手它盡快可以。通過檢查產品在細節可以制定一個計劃的攻擊，並開始撰寫一 組織結構。雖然你正在探索詳細的產品，做大量的筆記，因為這樣做，在最初的試探性階段，可以節省您的時間，可絕對重要的，如果你正在努力 最後期限。即使在規劃階段，必須確保有一個連貫性佈局，組織結構的文件。選擇編號公約，段落樣式，並產生粗糙的佈局思路 而現在，並將其保存的重要時刻later.Let跳水草案的inBefore為創造深入基層的文件，決議草案所載每個部分的第一個。這將允許重新安排，如果正在創建的文件沒有 邏輯'流'不認真而影響到項目。許多技術文件（尤其是更詳細的產品）是由許多（在某些情況下幾乎無數）迭代。這是 因為產品轉變和隨時間而改變，而其中的主要職責的技術作家，是跟上這些變化，並確保他們都是有據可查的。良好的技術作者將 他們始終把盡可能多的文件草稿，通過以不可思議的，每草案精煉，直到他們達到的位置，讓他們（和他們的雇主）認為該文件是及時，準確， 反映真實的產品或處理它documents.The魔鬼在detailAs已經確定，技術寫作的名字，是因為它是技術性的。部分是技術要準確， 精確和部分要盡可能詳細以不可思議的。即使您正在創建的文件是一個先進，技術先進的用戶群，你的文檔必須注重細節的 過程，或者使用的產品。這可能是一個難以完成壯舉，但如果你寫信給你的聽眾。從來沒有假設讀者知道任何有關產品或過程進行記錄，但在案件 先進/專家用戶至少有常識承認這一事實，他們可能並不需要知道如何使用他們的設備日常運作的基礎。當描述如何進行 特定的活動或任務，確定每個階段參與（人數他們，如果這符合公約的文件類型您正在創建），並確保準確，為你們的筆試自己動手，甚至 好，拉攏志願者相同的技能水平，最終user.Choose正確的工具的jobAlthough是有可能的技術文件創建使用羊皮紙和血液，這不可取的。許多專家 應用軟件存在，以幫助您創建強大的文檔，你的職責的一部分，作為一個技術作家，包括選擇合適的工具的工作。在很大程度上這取決於文件的性質 所生產，性質及其最終分配。如果文件可以交付使用互聯網，這當然是要考慮的途徑。為此，利用包，如Flash MX和 Dreamweaver中實現這一目標。綜合在線幫助，您可能希望創建原始的HTML文件，或者選擇一個專門的包，例如製作軟件或類似。在案件的打印文件， 您需要選擇一個軟件包，功能強大，足以應付你會扔it.Many經驗的技術作家即刻轉向微軟Word（因為它是無處不在5月商業和 私人環境）。除非你的文件將是下150頁，您知道如何創建模板，使宏，避免微軟Word。由於任何技術的作者都會告訴你有討厭的習慣，一切的 自己的，往往是一個不穩定的包工作。如果您正在創建大量的圖形文件，您不妨考慮Quark公司的Xpress，或選擇潛在的行業領導者在外地，Adobe公司Framemaker。 無論您選擇的軟件，你必須確保你變得令人難以置信精通它，無論是投資於培訓，或通過使用它一天又一天又一天！交流-這就是你的工資做！很多人 會告訴你，創建技術文件是乏味和重複。這些人，都是錯誤的，並可能低能兒了。雖然您可能會發現創建過程的技術文件'無聊'（如果你 你是在錯誤的工作！）事實並非如此。創建高質量的技術文件是一個重要的階段，讓人們充分和正確地使用技術。雖然沒有用戶將接近的文件中創建 同樣的方法，因為一種新的方法，你可以最終幫助他們實現他們想要達到使用技術。無論怎樣'沉悶'的過程中可能顯示為，使用戶能夠實現其目標的 讀您的文件應該給你一個繁忙的驕傲，而事實上，幸福。只要你還記得的積極效果，技術可以對人們的生活，當您創建您的文檔，您可以溝通 更有效，你會更快樂，在交際過程。在整個生命週期中的文件，你應尋求與同事保持聯繫，盡可能多（如適用）。讓他們讀你的 文件，聽取他們的批評，並調整您的文件（如果你不能說你的角落！）。一個技術作者支付的溝通，確保您做的，為什麼你永遠不會忘記的溝通，以及 其中，在文件themselves.Common錯誤，以避免makingWhen創建技術文件有一個數字是致命的缺陷可以使。雖然並非詳盡無遺，本節的一些細節較 常見的錯誤新的作者提出，在希望你會避免他們過於：作為光顧-儘管技術文件應明確，但絕不應光顧。您還沒有創建文件 予以由低能兒，但消費者和客戶。你應該總是寫的技能水平，你的聽眾，但不管是什麼人的技術水平上，他們不是低能兒。即使孩子生氣時，得到 光顧，不要犯類似的錯誤的人誰是你的薪水支付，子女或otherwise.Overuse幽默感-人們不讀技術文件，受理，他們閱讀他們成功的希望 完成一個過程，或提取信息。除非是相關的最終用戶，盡可能避免幽默。如果你正在寫一本書，罰款和好。如果你正在寫一本手冊，避免類似幽默 鼠疫，隨著越來越多的用戶往往會錯過笑話，只是最終厭惡的光顧白痴說寫documentation.Inconsistency -即使在起草階段，你應該確保所有的元素 在文檔中使用的是一致的。這同樣適用的'音'的文件，以它的佈局。確保使用一致的感覺（第一人等），以及頁面佈局，分頁元素， 頁眉和頁腳，以及所有其他文字elements.Proof閱讀-到年底創造一塊的技術文件，你可能會生病的忽略它。不要緊。什麼要緊的是什麼葉子 你的辦公室或家裡，是準確的。為此，閱讀文件，證明在所有它的匯票，並在其分佈證明再讀一遍，並不厭其煩。僅僅依賴拼寫檢查（他們沒有工作） 如果你能避免它，完全依賴自己的判斷。讓您的文檔閱讀許多雙眼睛盡可能在分配前，畢竟，他們可以當場一件事你一直失踪 在整個創作process.Conclusion /無恥的自我promotionTechnical書面不管是不是你所想，一件容易的事。它需要的專業知識，耐心和一個非常奇怪的混合技能。就像 任何其他的工作，你可以學習如何做到這一點，但即使這學費不一定會使你的出色。是一個很好的技術作家，你必須肛門的創造性，但集中交流，並靈活 專家。這，你也許可以想像，沒有簡單的任務。雖然你可能認為創建技術文件很容易，創造準確，一致和及時的文件到高的商業標準是 高度挑戰性的角色。無論您的預算，從長遠來看，將提供重要的投資回報率，如果你聘請的專家。畢竟，他們將能夠做的天，你的眼淚你的頭髮，我們試圖 在數週內完成，如果不months.About的AuthorOver坎普年麥克曾受聘為自由的IT記者（工作出版物，例如登記冊，Namesfacesplaces，關注安全和 PacketStorm的），撰稿人，電子遊戲設計師，安全審計，網頁設計師，平面設計師和IT培訓。他曾在多種自由和永久性的職位為小（如兩男一狗） 企業的跨國機構在整個英國和歐洲。當不工作的各種文章，書籍，手冊，以及各種其他副本的客戶，麥克通常可以找到在各種勞動的 未發表的小說。他有過幾次短暫的劇本，他生產的獨立製片公司，目前正在幾個功能長度scripts.Mike大多生活在不堪快樂
文章來源: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
網管得到HTML代碼
加上這條到你的網站！
網站管理員提交你的文章
無須登記！填寫好的表格和你的文章是在 Messaggiamo.Com 目錄！
