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