部署文档撰写经验分享
2011年，公司調(diào)我和幾個(gè)同事去廣西，與現(xiàn)場的同事一起撰寫部署文檔。去之前還感覺領(lǐng)導(dǎo)有點(diǎn)小題大做，寫個(gè)部署文檔至于么？我在公司半天就能寫出一版了，還叫這么多人跑到廣西寫這個(gè)，真是崽賣爺田不心疼，公司費(fèi)用隨便花。
到了廣西，負(fù)責(zé)人說了下部署文檔的要求：簡單明了、傻瓜部署。簡單明了指的是文字清楚、不能有歧義、不拽文、精練。傻瓜部署指的是文檔要寫好每一步的操作，傻瓜拿著這個(gè)文檔都能部署，不需要有專業(yè)的知識(shí)。
部署文檔分為平臺(tái)程序部署、數(shù)據(jù)庫部署、業(yè)務(wù)開通部署等模塊，筆者分到數(shù)據(jù)庫部署這一塊。平時(shí)我做部署時(shí)，對數(shù)據(jù)庫安裝有一些疑惑，趁此機(jī)會(huì)，把數(shù)據(jù)庫版本選擇及部署這塊也熟悉了一下。首先確認(rèn)數(shù)據(jù)庫版本，下載版本后一步步安裝，并把每一步的截圖都放到文章里，即使只是點(diǎn)擊下一步即可的截圖也放進(jìn)去。經(jīng)過十幾次部署后，把部署過程中遇到的各種問題，和自己的一些疑問也記錄下來，并做說明解答。
數(shù)據(jù)庫部署完畢后，開始做數(shù)據(jù)庫建立，數(shù)據(jù)備份導(dǎo)入。日常做數(shù)據(jù)庫割接升級(jí)前，一定要做數(shù)據(jù)庫備份，并做備份還原驗(yàn)證，看看備份后的數(shù)據(jù)是否能成功還原。然后再做數(shù)據(jù)割接升級(jí)。以一次升級(jí)割接數(shù)據(jù)庫為例，寫明這次割接的范圍、變更情況。把割接腳本每行寫上注釋，及是否需要根據(jù)本省情況進(jìn)行調(diào)整。撰寫割接升級(jí)腳本時(shí)，把數(shù)據(jù)庫IP地址、庫名等標(biāo)紅。各個(gè)省份現(xiàn)場升級(jí)時(shí)，修改為本地的數(shù)據(jù)庫地址和庫名即可。最后寫上FAQ，把一些日常工作答疑時(shí)，大家常問的一些數(shù)據(jù)升級(jí)問題和解決方案寫上。
最后寫數(shù)據(jù)割接腳本后，如何確認(rèn)是否遷移升級(jí)成功，提煉了幾條list清單，按照這幾項(xiàng)檢查，基本上能夠確認(rèn)本次升級(jí)成功。
文檔撰寫完畢后，我們幾個(gè)互相交換了下文檔，嚴(yán)格按照他們寫的文檔一步步操作，看是否能夠成功完成升級(jí)。然后整合大家提的意見，增加了部分自己認(rèn)為是常識(shí)，未做說明或未寫上的事項(xiàng)。
兩周后，部署文檔撰寫完畢。發(fā)給各省，果然收到各省的一致好評(píng)。省份同事說，以前做升級(jí)割接時(shí)，都是先研究下部署文檔，然后重新寫一版部署文檔，過程中還需要請教研發(fā)、DBA、技術(shù)支持等人員。現(xiàn)在直接按照這份文檔進(jìn)行升級(jí)即可。大大減少了省份的工作量，也減少了部署出現(xiàn)問題的幾率。
筆者后面也去了幾個(gè)省份做升級(jí)割接，發(fā)現(xiàn)每次升級(jí)割接時(shí)，按照之前撰寫的那版文檔，稍作改動(dòng)，調(diào)整成本次的腳本和程序即可完成升級(jí)。而且根據(jù)文檔后面的檢查list清單，基本上能夠保證99%以上的功能點(diǎn)都能使用。而不是之前升級(jí)后，自己隨機(jī)選取一些頁面進(jìn)行確認(rèn)，自我感覺沒有問題，但第二天客戶使用時(shí)發(fā)現(xiàn)一堆問題。
筆者后來負(fù)責(zé)一個(gè)群組項(xiàng)目，剛接手時(shí)就趕上五六十個(gè)省份并發(fā)檢查測試。省份維護(hù)人員對如何部署程序一無所知，全靠總部幾個(gè)研發(fā)測試人員全國奔波升級(jí)，大家當(dāng)時(shí)苦不堪言，其中一個(gè)人一個(gè)月跑了十幾個(gè)省升級(jí)。第二年我就召集各個(gè)省份的負(fù)責(zé)人來京，每個(gè)省份分配了幾項(xiàng)，總共61項(xiàng)。讓他們寫自己負(fù)責(zé)那幾項(xiàng)的部署確認(rèn)，問題檢查，疑點(diǎn)剖析等，然后讓大家做交叉檢查。歷時(shí)兩周完成了這版文檔，之后的幾年內(nèi)，檢查項(xiàng)也有調(diào)整，也出現(xiàn)過幾次五六十個(gè)省份并發(fā)測試檢查。但省份再也沒有提出部署割接的支持需求。
很多人對部署文檔都存在錯(cuò)誤的認(rèn)識(shí)，認(rèn)為其只是一個(gè)簡單的文檔，隨便一個(gè)人寫寫就行。殊不知它是系統(tǒng)上線交付用戶使用的關(guān)鍵一環(huán)。前期需求調(diào)研反復(fù)修改確認(rèn)，研發(fā)熬夜熬肝開發(fā)等，經(jīng)歷了萬里長征到最后勝利在望時(shí)，因?yàn)椴渴鹕?jí)的問題，導(dǎo)致好多功能不能正常使用，給客戶留下公司不專業(yè)的印象，那該多冤呢。
部署升級(jí)是現(xiàn)場維護(hù)人員日常維護(hù)的一項(xiàng)重要的指標(biāo)和工作內(nèi)容。如果公司總部不把部署文檔寫好，而靠各個(gè)現(xiàn)場根據(jù)自己的經(jīng)驗(yàn)和技術(shù)能力去保證割接升級(jí)的成功率，維護(hù)公司的形象。各個(gè)現(xiàn)場的人員水平層次不齊，而且各個(gè)現(xiàn)場維護(hù)人員做升級(jí)割接時(shí)，也不能保證自己的思路和想法能夠完美覆蓋公司的所有檢查項(xiàng)。那么升級(jí)割接的成功率可想而已，客戶對公司的印象也可想而知了。
總結(jié)
以上是生活随笔為你收集整理的部署文档撰写经验分享的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
