9月15日，廣東技術(shù)傳播社區(qū)第二次活動(dòng)在華僑城另空間順利舉辦。
當(dāng)天天氣炎熱至酷熱，氣象臺(tái)預(yù)測(cè)超強(qiáng)臺(tái)風(fēng)“山竹”將正面影響深圳。前一天得知“山竹”來(lái)勢(shì)洶洶，考慮是否調(diào)整活動(dòng)的時(shí)間。早上7點(diǎn)多艷陽(yáng)高照，果斷決定通知報(bào)名的小伙伴活動(dòng)如期進(jìn)行。
參與這次活動(dòng)的有新朋友和老朋友。吉祥騰達(dá)科技的 Celin ，第二次參加社區(qū)活動(dòng)，大學(xué)畢業(yè)就進(jìn)入技術(shù)傳播行業(yè)，從她的身上能感覺(jué)很強(qiáng)烈的學(xué)習(xí)和探索熱情，是社區(qū)的活躍成員。唐能翻譯的 Joanna 剛從上海來(lái)深圳定居，一直從事翻譯的客戶開(kāi)發(fā)和管理，希望通過(guò)活動(dòng)了解技術(shù)傳播行業(yè)。高亞科技的 Jane 一早從廣州出發(fā)，風(fēng)塵仆仆來(lái)到深圳，先和我們打招呼再去找吃飯的地方。大家滿滿的熱情和正能量！
感謝社區(qū)組委會(huì)小伙伴阿野為社區(qū)活動(dòng)找到了一個(gè)安靜、寬敞、明亮的聚會(huì)地點(diǎn)，同時(shí)降低了活動(dòng)場(chǎng)地費(fèi)用。
活動(dòng)的熱場(chǎng)環(huán)節(jié)依舊是自我介紹。無(wú)巧不成書(shū)—這次活動(dòng)的同行大多與翻譯行業(yè)有關(guān)系。有的正在從事翻譯職業(yè)，有的在翻譯公司開(kāi)發(fā)客戶和項(xiàng)目管理的，有的是從翻譯轉(zhuǎn)到技術(shù)寫(xiě)作崗位的。
互動(dòng)環(huán)節(jié)中，小伙伴們就工作、學(xué)習(xí)中的關(guān)注點(diǎn)（例如：DITA工具的選擇，高校語(yǔ)言專業(yè)的學(xué)生的就業(yè)方向，等等）進(jìn)行了討論和交流。
進(jìn)入分享環(huán)節(jié)，我先為小伙伴們介紹了使用代碼開(kāi)發(fā)工具和流程管理文檔的模式。軟件企業(yè)中的文檔團(tuán)隊(duì)采用敏捷模式開(kāi)發(fā)產(chǎn)品文檔，在內(nèi)容開(kāi)發(fā)工具和流程上存在許多“貌合神離”的地方，影響了文檔的交付和質(zhì)量。
技術(shù)文檔如何提高“含金量”，如何讓文檔開(kāi)發(fā)、管理、發(fā)布過(guò)程更“智能”，提高獲取性和可用性？我們可以借用代碼的開(kāi)發(fā)工具和流程。
使用輕量級(jí)標(biāo)記語(yǔ)言取代專門(mén)化寫(xiě)作工具，降低內(nèi)容開(kāi)發(fā)的門(mén)檻，工程團(tuán)隊(duì)與文檔團(tuán)隊(duì)協(xié)同開(kāi)發(fā)內(nèi)容，分別專注于技術(shù)細(xì)節(jié)與文檔架構(gòu)，從而提高技術(shù)文檔的“含金量”；文檔評(píng)審流程借用代碼評(píng)審機(jī)制，跟蹤文檔中待改進(jìn)的問(wèn)題，激發(fā)評(píng)審興趣的同時(shí)，提升內(nèi)容質(zhì)量；代碼開(kāi)發(fā)流程的自動(dòng)化工具應(yīng)用于質(zhì)量檢查，減少人工和重復(fù)工作，讓內(nèi)容貢獻(xiàn)者專注于開(kāi)發(fā)文檔內(nèi)容；持續(xù)集成和持續(xù)交付工具，定期集成很新版本，一鍵式網(wǎng)站發(fā)布，提高文檔的獲取性和可用性。
國(guó)內(nèi)外的企業(yè)使用文檔代碼化的模式對(duì)技術(shù)文檔，特別是面向開(kāi)發(fā)者的文檔、技術(shù)支持文檔轉(zhuǎn)換，收到了不錯(cuò)的效果，將轉(zhuǎn)換經(jīng)驗(yàn)在Write the Docs 社區(qū)大會(huì)和企業(yè)博客分享。
前華為信息架構(gòu)專家李琳 Emma （公眾號(hào)：技術(shù)傳播李琳）為大家分享了三個(gè)DITA 實(shí)施案例。
Emma向大家深入介紹了使用DITA結(jié)構(gòu)化寫(xiě)作的優(yōu)勢(shì)。借用人類演進(jìn)圖描述了結(jié)構(gòu)化寫(xiě)作是企業(yè)技術(shù)文檔寫(xiě)作演進(jìn)歷程中的先進(jìn)階段，結(jié)構(gòu)化寫(xiě)作有效地解決了工業(yè)化寫(xiě)作的痛點(diǎn)。結(jié)構(gòu)化寫(xiě)作對(duì)信息分類，與產(chǎn)品功能和規(guī)格相關(guān)的信息以概念類和參考類主題進(jìn)行描述，指導(dǎo)用戶完成產(chǎn)品操作和排除故障的說(shuō)明性信息以任務(wù)類型進(jìn)行描述，通過(guò)信息分類對(duì)內(nèi)容進(jìn)行結(jié)構(gòu)化、模塊化。
結(jié)構(gòu)化寫(xiě)作中按自上而下（Top-down）的架構(gòu)設(shè)計(jì)文檔，基于使用場(chǎng)景，設(shè)計(jì)內(nèi)容模塊與交付方式，完成內(nèi)容開(kāi)發(fā)后，按交付模式發(fā)布。自上而下的信息架構(gòu)設(shè)計(jì)保證了實(shí)現(xiàn)企業(yè)的業(yè)務(wù)價(jià)值，有效傳遞產(chǎn)品的設(shè)計(jì)意圖，提高文檔團(tuán)隊(duì)并行開(kāi)發(fā)的能力，適應(yīng)讀者（用戶）的需求變化，提高內(nèi)容的重復(fù)使用能力。
產(chǎn)品信息的開(kāi)發(fā)貫穿整個(gè)產(chǎn)品生命周期。例如，在產(chǎn)品需求分析和整理階段輸出功能清單，設(shè)計(jì)階段輸出規(guī)格參數(shù)，開(kāi)發(fā)階段輸出接口說(shuō)明，維護(hù)階段輸出故障排除指導(dǎo)說(shuō)明。通過(guò)內(nèi)容管理系統(tǒng)設(shè)計(jì)和定義信息的流動(dòng)，將內(nèi)容板塊按需整合為不同類型的手冊(cè)（例如：硬件手冊(cè)、軟件手冊(cè)、操作手冊(cè)和維護(hù)手冊(cè)），以多種格式發(fā)布到交付門(mén)戶網(wǎng)站。產(chǎn)品信息在內(nèi)容管理生態(tài)體系中得到有效的繁衍、管理和使用。
Emma 逐個(gè)分析不同的結(jié)構(gòu)化寫(xiě)作案例中的利與弊。案例一，Microsoft Word中的豐富段落樣式，自定義文檔模板，自帶的語(yǔ)言檢查工具，滿足了文檔團(tuán)隊(duì)從編寫(xiě)、管理、排版輸出的多方面要求，讓文檔團(tuán)隊(duì)有了“正規(guī)軍”的感覺(jué)。使用Word工具維護(hù)文檔也有一些不盡人意的地方，例如插圖和排版。案例二，從Word到DITA，從TW的角度看，雖然工具不同了，區(qū)別不大，還是結(jié)構(gòu)化寫(xiě)作，只是內(nèi)容和樣式分離了，也需要花費(fèi)學(xué)習(xí)成本。案例三，從DITA到內(nèi)容管理系統(tǒng)，編寫(xiě)、評(píng)審流程更高效了，快速重用內(nèi)容模塊，文檔管理省時(shí)省力，但系統(tǒng)復(fù)雜、使用流程工序多，發(fā)布的還是以往的內(nèi)容。
Emma總結(jié)：DITA正在并將會(huì)以輕量化、專門(mén)化、可視化、云化演進(jìn)。
然后，我向大家介紹了下半年國(guó)內(nèi)外行業(yè)活動(dòng)，包括9月中在杭州舉辦的中國(guó)技術(shù)傳播論壇，11月將在荷蘭鹿特丹舉辦的DITA-OT Day, DITA/CMS歐洲大會(huì)以及在德國(guó)斯圖加特舉辦的tcworld 2018大會(huì)。
活動(dòng)在愉快的氣氛中結(jié)束。希望大家在此次社區(qū)活動(dòng)中收獲知識(shí)。
本文摘自博客“無(wú)問(wèn)西東”。
