程序員-文檔工程師課件

程序員成長(zhǎng)系列之——從程序員到文檔工程師程序員成長(zhǎng)系列之——從程序員到文檔工程師1從程序員到文檔工程師

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

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

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

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

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

程序員成長(zhǎng)系列之——從程序員到文檔工程師程序員成長(zhǎng)系列之——從程序員到文檔工程師21從程序員到文檔工程師

從某個(gè)角度看“程序員”這個(gè)稱呼已經(jīng)無法涵蓋軟件公司中各種角色的職責(zé)和特點(diǎn)，成熟軟件公司中會(huì)有這個(gè)職位，但是在很多小規(guī)模公司中，文檔工程師只是一種角色，而不一定有職位設(shè)置。從程序員到文檔工程師從某個(gè)角度看“程序22程序員成長(zhǎng)方向程序員軟件設(shè)計(jì)師測(cè)試工程師文檔工程師產(chǎn)品經(jīng)理配置管理員項(xiàng)目經(jīng)理程序員成長(zhǎng)方向程序員軟件設(shè)計(jì)師測(cè)試工程師文檔工程師產(chǎn)品經(jīng)理配23從程序員到文檔工程師在國(guó)外，文檔工程師是非常重要的角色，因?yàn)樗邮艽罅康摹⒏咚疁?zhǔn)讀者的考驗(yàn)，而且要跟蹤不斷創(chuàng)新的技術(shù)，感受產(chǎn)品周期的壓力，其重要程度不亞于系統(tǒng)分析員。以加拿大為例：同樣四年經(jīng)驗(yàn)的系統(tǒng)分析員的薪水在￥55000；而文檔工程師為￥65000屬于專業(yè)職能，在技術(shù)移民中的評(píng)分為50，高于牙醫(yī)、建筑設(shè)計(jì)師，電機(jī)工程師（40）等工作種類。然而在國(guó)內(nèi)，人們的印象中，文檔工程師還是屬于低級(jí)“碼字”的角色，很多“真正的”程序員對(duì)此工作不屑一顧。不過隨著軟件業(yè)的規(guī)范，國(guó)外先進(jìn)軟件開發(fā)方法的進(jìn)入和推廣，文檔工程師越來越受重視，在chinaHR／51job等人才招聘網(wǎng)站，每星期都有很多空缺。從程序員到文檔工程師在國(guó)外，文檔工程師是非常重要的角色，因?yàn)?4從程序員到文檔工程師

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

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

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