程序員成長系列之——從程序員到文檔工程師程序員成長系列之——從程序員到文檔工程師1從程序員到文檔工程師

從某個角度看“程序員”這個稱呼已經無法涵蓋軟件公司中各種角色的職責和特點，成熟軟件公司中會有這個職位，但是在很多小規模公司中，文檔工程師只是一種角色，而不一定有職位設置。從程序員到文檔工程師從某個角度看“程序2程序員成長方向程序員軟件設計師測試工程師文檔工程師產品經理配置管理員項目經理程序員成長方向程序員軟件設計師測試工程師文檔工程師產品經理配3從程序員到文檔工程師在國外，文檔工程師是非常重要的角色，因為他要接受大量的、高水準讀者的考驗，而且要跟蹤不斷創新的技術，感受產品周期的壓力，其重要程度不亞于系統分析員。以加拿大為例：同樣四年經驗的系統分析員的薪水在￥55000；而文檔工程師為￥65000屬于專業職能，在技術移民中的評分為50，高于牙醫、建筑設計師，電機工程師（40）等工作種類。然而在國內，人們的印象中，文檔工程師還是屬于低級“碼字”的角色，很多“真正的”程序員對此工作不屑一顧。不過隨著軟件業的規范，國外先進軟件開發方法的進入和推廣，文檔工程師越來越受重視，在chinaHR／51job等人才招聘網站，每星期都有很多空缺。從程序員到文檔工程師在國外，文檔工程師是非常重要的角色，因為4從程序員到文檔工程師

由于軟件開發中項目繁多，輸出文檔的分散和更新不及時，開發人員使用的工具多樣化，多種版本和工具并存種種原因導致開發過程中存在很多問題。部門主管無法確切得知項目的進展情況，項目經理不能準確掌握各開發人員的具體工作，項目進展隨意性較大；項目之間溝通不夠各個開發人員編寫的代碼風格差異，而且編碼和設計脫節。如果溝通不及時或被忽視，容易造成開發工作的重復，留下大量難維護的代碼；文檔與程序嚴重脫節，軟件產品是公司的寶貴財富，代碼的重用率是相當高的，因此建好知識庫是對公司優質高效開發產品的推動。這些問題的解決都需要文檔工程師的積極參與.從程序員到文檔工程師由于軟件開發中項目5文檔工程師的職責：在RUP（統一軟件開發過程）中，文檔工程師負責內部軟件文檔、用戶手冊編寫及演示版本的制作，除此之外，軟件開發過程中的文檔控制與規范也屬于文檔工程師的職責范圍。實際上，在軟件開發過程中，文檔很難單獨存在，它需要由文檔工程師和開發人員共同完成。其中開發人員扮演信息源的角色，文檔工程師扮演一個信息處理中心的角色，主要負責文檔工作的質量。從程序員到文檔工程師文檔工程師的職責：從程序員到文檔工程師6收集/提出文檔需求安排文檔開發計劃制定各類文檔模板跟蹤文檔編寫進度編輯文檔文檔的管理從程序員到文檔工程師收集/提出文檔需求從程序員到文檔工程師7收集／提出文檔需求：對設計部門文檔的需求來自項目外（客戶，市場部維護部門，其他項目等）或者項目內。文檔工程師需要有良好的溝通技巧。通過與客戶和其他部門的交流，獲得他們在文檔方面的需求，項目內的文檔需求可以根據軟件工程的知識，由項目經理或文檔人員自己提出。從程序員到文檔工程師收集／提出文檔需求：從程序員到文檔工程師8安排文檔開發計劃：文檔開發計劃是在需求達到一定程度后，安排計劃編寫的相應文檔。文檔開發計劃的制定需要考慮目前開發人員的開發任務，文檔需求的緊急程度，文檔編寫的難度等因素。所以文檔開發計劃的安排主要應該由項目經理來負責，其中文檔工程師起協助的作用。但是，如果文檔工程師對項目有足夠的了解，計劃草搞可以由文檔工程師制定，再由項目經理確認。從程序員到文檔工程師安排文檔開發計劃：從程序員到文檔工程師9制定各類文檔模板：制定各種模板是文檔工程師的主要職責之一，文檔模板和文檔編寫的指南對統一文檔風格非常重要，因為大部分的文檔需要各個開發人員編寫不同的部分，如果沒有統一的模板和明確的指南，很可能開發人員提交出風格各異，詳細程度不同的文檔，這給后期的編輯工作帶來了很大的困難，而且文檔質量難以控制。文檔模板可以根據經驗制定，也可以參考一些成熟的開發模型如RUP提供的參考模板，刪節修改后在項目內使用。從程序員到文檔工程師制定各類文檔模板：從程序員到文檔工程師10跟蹤文檔編寫的進度：在項目經理確定文檔開發計劃，把任務分配給具體的開發人員后，文檔工程師需要不斷的跟進文檔編寫任務的完成狀況。跟蹤進度的工作可以通過一些項目管理工具來輔佐。從程序員到文檔工程師跟蹤文檔編寫的進度：從程序員到文檔工程師11編輯文檔：編輯文檔就是對開發人員提交的原始文檔進行合并整理，修改，統一語言風格等工作。完成后，由文檔工程師初步檢查一次，成為一份草稿狀態的文檔，然后將文檔提交給相關的人員檢查，如項目經理或CTO，其他部門負責人等，檢查人發現需要校正的地方，應該獨立做校正表，或者在原文檔中做批注，而不應直接修改原文檔，最后的校正工作由文檔工程師根據校正表或者批注完成，成為一份核實狀態的文檔。在需要發布的時候應該先對文檔做評審，通過評審才能標識為發布狀態。測試人員可以認為是特殊的文檔人員，負責編寫／編輯測試文檔。從程序員到文檔工程師編輯文檔：從程序員到文檔工程師12文檔的管理：文檔工程師應該負責：集中存儲所有文檔資料；文檔的變更管理；保證文檔版域代碼版本的一致性；維護文檔資料的索引表；配合IT人員定期備份文檔資料。從程序員到文檔工程師文檔的管理：從程序員到文檔工程師13如何做好文檔工程師：

要做好文檔工程師的工作，首選要明確文檔的價值所在。從信息載體角度看，文檔中記錄的可能是雜亂無章的數據，這些信息在某個項目或階段完成后就無用了，同時也可以通過提取信息中的知識，提高其價值，甚至可以變成公司的資產。軟件文檔分為內部文檔和外部文檔。內部文檔主要是用來做決策支持，外部文檔一般指用戶文檔（主要是軟件說明文檔）和客戶文檔（主要是需求文檔）。文檔工程師只有了解這些，才能更好的看待文檔的價值。從程序員到文檔工程師如何做好文檔工程師：從程序員到文檔工程師14文檔工程師的工具：文檔工程師除了要學會利用Word、Ebook、Help、Visio、Html、ProjectPowerpoint、Acrobat等各種軟件，還要盡可能學會使用軟件工程的軟件來協助提高工作效率，同時提高自身素質。從程序員到文檔工程師文檔工程師的工具：從程序員到文檔工程師15文檔的分類：

在軟件開發中，需求定義、規格說明、開發計劃、使用說明、聯機幫助等各種過程都會產生大量文檔，都需要文檔工程師參與。有些開發方法甚至建議在編碼開始之前，用戶文檔就已經基本編寫完成，這需要文檔工程師在文檔管理方面有更專業的素質。用戶教育文檔客戶支持文檔開發文檔從程序員到文檔工程師文檔的分類：從程序員到文檔工程師16用戶教育文檔：用戶教育文檔用于幫助用戶認識產品，提供足夠的指引使用戶能夠安裝、使用產品以及進行一些必要的日常維護工作。用戶教育文檔的結構和內容，應該在系統設計確定后，就由系統實施人員開始設計，并且在整個開發過程中不斷的調整完善，最后和產品軟件包一起，作為產品的一部分，發布給用戶。具體應該編寫哪些用戶教育文檔？這沒有統一的標準，需要首先分析清楚有哪幾種用戶，每種用戶圍繞產品所必須要進行的一些活動。要得到這些信息，可以參考開發文檔中的需求分析文檔。在分析出用戶和用戶圍繞產品而進行的活動得出一個必須編寫的文檔內容列表，可以考慮根據活動的頻率和相關性，將各部分組合成若干份文檔。從程序員到文檔工程師用戶教育文檔：從程序員到文檔工程師17客戶支持文檔：

主要包括項目管理文檔、培訓文檔、需求分析文檔、項目變更文檔和批準書、基礎數據準備和批準文檔、軟件安裝文檔、軟件客戶化和二次開發文檔、軟件參數設置文檔、測試方案和測試結果報告、階段成果確認書、會議紀要、計劃書及計劃變更說明書等等。客戶支持文檔主要包括系統更深層次的描述，更高級的使用技巧等，具體應該包括哪些內容，可以在設計階段的可維護性設計時列出，也可以由維護部門根據以往的維護經驗提出需求。從程序員到文檔工程師客戶支持文檔：從程序員到文檔工程師18開發文檔：開發文檔貫穿軟件開發過程的各個階段，在項目組內可以分為Requirement（需求），Design（設計），Implementation（實現），Testing（測試），Release（發布），Communication（溝通），Management（管理），Research（研究），Changelog（變更）和Training（培訓）幾個大類。各大類下面可以根據實際需要分為不同的子分類。從程序員到文檔工程師開發文檔：從程序員到文檔工程師19演講完畢，謝謝觀看！演講完畢，謝謝觀看！20

程序員成長系列之——從程序員到文檔工程師程序員成長系列之——從程序員到文檔工程師21從程序員到文檔工程師

從某個角度看“程序員”這個稱呼已經無法涵蓋軟件公司中各種角色的職責和特點，成熟軟件公司中會有這個職位，但是在很多小規模公司中，文檔工程師只是一種角色，而不一定有職位設置。從程序員到文檔工程師從某個角度看“程序22程序員成長方向程序員軟件設計師測試工程師文檔工程師產品經理配置管理員項目經理程序員成長方向程序員軟件設計師測試工程師文檔工程師產品經理配23從程序員到文檔工程師在國外，文檔工程師是非常重要的角色，因為他要接受大量的、高水準讀者的考驗，而且要跟蹤不斷創新的技術，感受產品周期的壓力，其重要程度不亞于系統分析員。以加拿大為例：同樣四年經驗的系統分析員的薪水在￥55000；而文檔工程師為￥65000屬于專業職能，在技術移民中的評分為50，高于牙醫、建筑設計師，電機工程師（40）等工作種類。然而在國內，人們的印象中，文檔工程師還是屬于低級“碼字”的角色，很多“真正的”程序員對此工作不屑一顧。不過隨著軟件業的規范，國外先進軟件開發方法的進入和推廣，文檔工程師越來越受重視，在chinaHR／51job等人才招聘網站，每星期都有很多空缺。從程序員到文檔工程師在國外，文檔工程師是非常重要的角色，因為24從程序員到文檔工程師

由于軟件開發中項目繁多，輸出文檔的分散和更新不及時，開發人員使用的工具多樣化，多種版本和工具并存種種原因導致開發過程中存在很多問題。部門主管無法確切得知項目的進展情況，項目經理不能準確掌握各開發人員的具體工作，項目進展隨意性較大；項目之間溝通不夠各個開發人員編寫的代碼風格差異，而且編碼和設計脫節。如果溝通不及時或被忽視，容易造成開發工作的重復，留下大量難維護的代碼；文檔與程序嚴重脫節，軟件產品是公司的寶貴財富，代碼的重用率是相當高的，因此建好知識庫是對公司優質高效開發產品的推動。這些問題的解決都需要文檔工程師的積極參與.從程序員到文檔工程師由于軟件開發中項目25文檔工程師的職責：在RUP（統一軟件開發過程）中，文檔工程師負責內部軟件文檔、用戶手冊編寫及演示版本的制作，除此之外，軟件開發過程中的文檔控制與規范也屬于文檔工程師的職責范圍。實際上，在軟件開發過程中，文檔很難單獨存在，它需要由文檔工程師和開發人員共同完成。其中開發人員扮演信息源的角色，文檔工程師扮演一個信息處理中心的角色，主要負責文檔工作的質量。從程序員到文檔工程師文檔工程師的職責：從程序員到文檔工程師26收集/提出文檔需求安排文檔開發計劃制定各類文檔模板跟蹤文檔編寫進度編輯文檔文檔的管理從程序員到文檔工程師收集/提出文檔需求從程序員到文檔工程師27收集／提出文檔需求：對設計部門文檔的需求來自項目外（客戶，市場部維護部門，其他項目等）或者項目內。文檔工程師需要有良好的溝通技巧。通過與客戶和其他部門的交流，獲得他們在文檔方面的需求，項目內的文檔需求可以根據軟件工程的知識，由項目經理或文檔人員自己提出。從程序員到文檔工程師收集／提出文檔需求：從程序員到文檔工程師28安排文檔開發計劃：文檔開發計劃是在需求達到一定程度后，安排計劃編寫的相應文檔。文檔開發計劃的制定需要考慮目前開發人員的開發任務，文檔需求的緊急程度，文檔編寫的難度等因素。所以文檔開發計劃的安排主要應該由項目經理來負責，其中文檔工程師起協助的作用。但是，如果文檔工程師對項目有足夠的了解，計劃草搞可以由文檔工程師制定，再由項目經理確認。從程序員到文檔工程師安排文檔開發計劃：從程序員到文檔工程師29制定各類文檔模板：制定各種模板是文檔工程師的主要職責之一，文檔模板和文檔編寫的指南對統一文檔風格非常重要，因為大部分的文檔需要各個開發人員編寫不同的部分，如果沒有統一的模板和明確的指南，很可能開發人員提交出風格各異，詳細程度不同的文檔，這給后期的編輯工作帶來了很大的困難，而且文檔質量難以控制。文檔模板可以根據經驗制定，也可以參考一些成熟的開發模型如RUP提供的參考模板，刪節修改后在項目內使用。從程序員到文檔工程師制定各類文檔模板：從程序員到文檔工程師30跟蹤文檔編寫的進度：在項目經理確定文檔開發計劃，把任務分配給具體的開發人員后，文檔工程師需要不斷的跟進文檔編寫任務的完成狀況。跟蹤進度的工作可以通過一些項目管理工具來輔佐。從程序員到文檔工程師跟蹤文檔編寫的進度：從程序員到文檔工程師31編輯文檔：編輯文檔就是對開發人員提交的原始文檔進行合并整理，修改，統一語言風格等工作。完成后，由文檔工程師初步檢查一次，成為一份草稿狀態的文檔，然后將文檔提交給相關的人員檢查，如項目經理或CTO，其他部門負責人等，檢查人發現需要校正的地方，應該獨立做校正表，或者在原文檔中做批注，而不應直接修改原文檔，最后的校正工作由文檔工程師根據校正表或者批注完成，成為一份核實狀態的文檔。在需要發布的時候應該先對文檔做評審，通過評審才能標識為發布狀態。測試人員可以認為是特殊的文檔人員，負責編寫／編輯測試文檔。從程序員到文檔工程師編輯文檔：從程序員到文檔工程師32文檔的管理：文檔工程師應該負責：集中存儲所有文檔資料；文檔的變更管理；保證文檔版域代碼版本的一致性；維護文檔資料的索引表；配合IT人員定期備份文檔資料。從程序員到文檔工程師文檔的管理：從程序員到文檔工程師33如何做好文檔工程師：

要做好文檔工程師的工作，首選要明確文檔的價值所在。從信息載體角度看，文檔中記錄的可能是雜亂無章的數據，這些信息在某個項目或階段完成后就無用了，同時也可以通過提取信息中的知識，提高其價值，甚至可以變成公司的資產。軟件文檔分為內部文檔和外部文檔。內部文檔主要是用來做決策支持，外部文檔一般指用戶文檔（主要是軟件說明文檔）和客戶文檔（主要是需求文檔）。文檔工程師只有了解這些，才能更好的看待文檔的價值。從程序員到文檔工程師如何做好文檔工程師：從程序員到文檔工程師34文檔工程師的工具：文檔工程師除了要學會利用Word、Ebook、Help、Visio、Html、ProjectPowerpoint、Acrobat等各種軟件，還要盡可能學會使用軟件工程的軟件來協助提高工作效率，同時提高自身素質。從程序員到文檔工程師文檔工程師的工具：從程序員到文檔工程師35文檔的分類：

在軟件開發中，需求定義、規格說明、開發計劃、使用說明、聯機幫助等各種過程都會產生大量文檔，都需要文檔工程師參與。有些開發方法甚至建議在編碼開始之前，用戶文檔就已經基本編寫完成，這需要文檔工程師在文檔管理方面有更專業的素質。用戶教育文檔客戶支持文檔開發文檔從程序員到文檔工程師文檔的分類：從程序員到文檔工程師36用戶教育文檔：用戶教育文檔用于幫助用戶認識產品，提供足夠的指引使用戶能夠安裝、使用產品以及進行一些必要的日常維護工作。用戶教育文檔的結構和內容，應該在系統設計確定后，就由系統實施