王莉:将开发文档英文化和本地化,我们努力让OpenHarmony走向全球
編者按:在 OpenHarmony 生態(tài)發(fā)展過(guò)程中,涌現(xiàn)了大批優(yōu)秀的代碼貢獻(xiàn)者,本專(zhuān)題旨在表彰貢獻(xiàn)、分享經(jīng)驗(yàn),文中內(nèi)容來(lái)自嘉賓訪(fǎng)談,不代表 OpenHarmony 工作委員會(huì)觀點(diǎn)。
王莉
華為技術(shù)有限公司
翻譯及本地化工程師
對(duì)于開(kāi)源項(xiàng)目及其開(kāi)發(fā)者而言,一份書(shū)寫(xiě)規(guī)范、質(zhì)量上乘、及時(shí)更新的開(kāi)發(fā)者文檔是至關(guān)重要的——它能幫助開(kāi)發(fā)者快速入門(mén),檢視代碼邏輯,提升開(kāi)發(fā)效率,從而吸引更多開(kāi)發(fā)者加入,繁榮開(kāi)源生態(tài)。
作為由開(kāi)放原子開(kāi)源基金會(huì)孵化及運(yùn)營(yíng)的開(kāi)源項(xiàng)目,OpenAtom OpenHarmony(以下簡(jiǎn)稱(chēng)“OpenHarmony”)在誕生初期也曾面臨開(kāi)發(fā)者文檔太少、質(zhì)量不夠高等窘境。經(jīng)過(guò) OpenHarmony 工作委員會(huì)、各家共建單位的開(kāi)發(fā)者們一年多的努力,我們很欣喜地看到開(kāi)發(fā)者文檔一點(diǎn)點(diǎn)變得豐富,系統(tǒng)能力不斷構(gòu)建,代碼也在不斷完善。
華為翻譯及本地化工程師王莉,正是這些參與文檔共建的開(kāi)發(fā)者中的一員。
在近期 OpenHarmony PMC(Project Management Committee 項(xiàng)目管理委員會(huì))舉行的 2022 年 2 月份代碼貢獻(xiàn)者評(píng)選中,王莉因?yàn)樵陂_(kāi)發(fā)者文檔領(lǐng)域的突出貢獻(xiàn),成功被評(píng)為“代碼貢獻(xiàn)月度之星”,成為代碼貢獻(xiàn) Top10 的兩位女性開(kāi)發(fā)者之一。
王莉和她所在的團(tuán)隊(duì),主要貢獻(xiàn)點(diǎn)在于社區(qū)的英文化和本地化。加入 OpenHarmony 項(xiàng)目后,他們和資料團(tuán)隊(duì)一起學(xué)習(xí)和研究了業(yè)界主流的 SIG,組建了自己的 SIG docs;制定了社區(qū)行為準(zhǔn)則、貢獻(xiàn)流程、優(yōu)化問(wèn)題反饋和處理機(jī)制;制定了代碼規(guī)范和寫(xiě)作模板,植入了 CI 門(mén)禁工具、自動(dòng)提交翻譯 Issue 的 bot,并輸出了 OpenHarmony 各個(gè)子系統(tǒng)的相關(guān)指導(dǎo)文檔,幫助開(kāi)發(fā)者們更加輕松、愉快地使用 OpenHarmony。
本期 OpenHarmony 開(kāi)發(fā)者故事,我們與王莉一起聊了她和她所在的團(tuán)隊(duì)、參與 OpenHarmony 項(xiàng)目的初心、代碼貢獻(xiàn)如此突出的心得、SIG docs 運(yùn)營(yíng)過(guò)程中的趣事,以及開(kāi)源過(guò)程中遇到的技術(shù)難題、對(duì) OpenHarmony 未來(lái)的期待等話(huà)題。現(xiàn)將專(zhuān)訪(fǎng)內(nèi)容整理如下,希望對(duì)你有所啟發(fā)。
Q=OpenHarmony A=王莉
Q1:請(qǐng)簡(jiǎn)要介紹下自己,以及所在開(kāi)發(fā)團(tuán)隊(duì)
大家好,我是來(lái)自華為的王莉,是一名翻譯及本地化工程師,目前主要從事 OpenHarmony 相關(guān)文檔的翻譯及本地化工作。目前我們團(tuán)隊(duì)主要活躍在 SIG docs,負(fù)責(zé) OpenHarmony 項(xiàng)目所有文檔的中到英翻譯工作,常見(jiàn)的比如 API 參考、readme、操作指導(dǎo)等翻譯,外籍輸出件的 PR,以及輸出相關(guān)的本地化貢獻(xiàn)指導(dǎo)、規(guī)范和 FAQ。
此外,我們還攜手近 10 名資料工程師以及數(shù)百位開(kāi)發(fā)工程師,結(jié)對(duì)優(yōu)化中文資料。希望能夠通過(guò)我們的工作,讓更多的開(kāi)發(fā)者高效地了解和使用 OpenHarmony。
Q2:作為一名翻譯及本地化工程師,您最初為什么會(huì)選擇加入OpenHarmony生態(tài)、參與開(kāi)源共建呢?您認(rèn)為,OpenHarmony項(xiàng)目最吸引人的點(diǎn)在哪里?
我在加入 OpenHarmony 項(xiàng)目之前,曾經(jīng)做過(guò)計(jì)算的產(chǎn)品,從我對(duì)口的產(chǎn)品一開(kāi)始清一色的 Intel 處理器,到我們自己的鯤鵬和昇騰處理器,再到生機(jī)勃勃的鯤鵬生態(tài)、方興未艾的 OpenHarmony 生態(tài)……一路走來(lái),我們清楚地知道 OpenHarmony 項(xiàng)目的重要性,更明白開(kāi)源的重大意義。
OpenHarmony 是一項(xiàng)偉大的事業(yè),我能通過(guò)自己的專(zhuān)業(yè)能力為社區(qū)貢獻(xiàn)一份力,這讓我覺(jué)得這個(gè)工作是非常有價(jià)值的。
Q3:這次您被OpenHarmony PMC委員會(huì)推舉為“代碼貢獻(xiàn)月度之星”,意味著您對(duì)OpenHarmony項(xiàng)目的貢獻(xiàn)已經(jīng)屬于業(yè)界頂尖水平,十分了不起!加入OpenHarmony這么短的時(shí)間卻達(dá)成了這樣好的效果,請(qǐng)問(wèn)您的“秘訣”是什么?您是否方便從業(yè)務(wù)角度具體介紹一下,怎么才能讓開(kāi)發(fā)者更加滿(mǎn)意,把開(kāi)源共建做得更好呢?
我和我所在的團(tuán)隊(duì),對(duì)社區(qū)的主要貢獻(xiàn)點(diǎn)在于社區(qū)的英文化和本地化,與代碼貢獻(xiàn)者還是有所區(qū)別的。所以能在 OpenHarmony 這次評(píng)選中獲得“代碼貢獻(xiàn)月度之星”,我其實(shí)覺(jué)得十分意外,同時(shí)又倍受鼓舞。
一開(kāi)始加入項(xiàng)目組,我感覺(jué)挑戰(zhàn)還是挺大的。雖然我是一名語(yǔ)言工作者,但并不熟悉開(kāi)發(fā)語(yǔ)言;對(duì)于 OpenHarmony 所涉及的眾多子系統(tǒng)和技術(shù),也覺(jué)得 gap 很大;對(duì)于 SIG docs 的運(yùn)作也一無(wú)所知……
好在興趣是最好的老師,缺什么就補(bǔ)什么,這個(gè)過(guò)程必定是先苦然后慢慢一點(diǎn)一點(diǎn)地甜。作為開(kāi)發(fā)者文檔最認(rèn)真的讀者,我們必須要理解文檔的每一話(huà)。同時(shí),作為最初的體驗(yàn)者,我們也能站在讀者的角度上,發(fā)現(xiàn)一些問(wèn)題,對(duì)文檔提出一些優(yōu)化建議。對(duì)于 SIG 的運(yùn)作,我們的小團(tuán)隊(duì)也和資料團(tuán)隊(duì)一起,在不斷地探索和改進(jìn)……
我們的目標(biāo),從小了說(shuō)是讓資料好用、易用、開(kāi)發(fā)者喜歡用,從大了說(shuō)是提供一個(gè)知識(shí)、能力分享的平臺(tái),點(diǎn)亮更多開(kāi)發(fā)者。這一目標(biāo)的達(dá)成,也和開(kāi)源生態(tài)的建設(shè)一樣,需要大家一起貢獻(xiàn)自己的智慧和力量。
Q4:您和您的團(tuán)隊(duì)小伙伴,在參與OpenHarmony項(xiàng)目貢獻(xiàn)的過(guò)程中,一定有一些刻骨銘心/印象深刻的經(jīng)歷,比如組建和參與SIG docs運(yùn)營(yíng)之類(lèi)。可以給我們分享一下嗎?
我之前完全沒(méi)有接觸過(guò)開(kāi)源項(xiàng)目,對(duì)于開(kāi)源的理解也僅限于字面意思。
在加入到 OpenHarmony 這個(gè)項(xiàng)目以后,我們團(tuán)隊(duì)和資料團(tuán)隊(duì)都在這方面下了很多工夫。我們學(xué)習(xí)和研究了業(yè)界主流的 SIG,組建了自己的 SIG docs;制定了社區(qū)行為準(zhǔn)則、貢獻(xiàn)流程、優(yōu)化問(wèn)題反饋和處理機(jī)制;制定了代碼規(guī)范和寫(xiě)作模板,植入了 CI 門(mén)禁工具、自動(dòng)提交翻譯 Issue 的 bot,并輸出了 OpenHarmony 各個(gè)子系統(tǒng)的相關(guān)指導(dǎo)文檔。目前,SIG docs 已成為 OpenHarmony 社區(qū)最活躍的 SIG 之一,關(guān)注量和 Fork 數(shù)量都遙遙領(lǐng)先。
與以前翻譯工作不同的是,我們需要在 Gitee 上處理文檔,為此我們專(zhuān)門(mén)學(xué)習(xí)了 markdown 語(yǔ)法、Gitee 的常見(jiàn)操作命令等。
一開(kāi)始由于不了解 Gitee 文檔的運(yùn)作機(jī)制,感覺(jué)整個(gè)操作流程很是復(fù)雜;在提交 PR 的時(shí)候,也遇到過(guò)各種問(wèn)題,最初的時(shí)候,經(jīng)常有挫敗感。
在不斷的試錯(cuò)過(guò)程中,我們把工作中的經(jīng)驗(yàn)和教訓(xùn)都記錄下來(lái),形成了我們的《開(kāi)源項(xiàng)目翻譯操作指導(dǎo)書(shū)》,這樣可以固化下來(lái)的東西就成了我們的操作規(guī)范,也方便更多的愛(ài)好者可以很快地上手為社區(qū)做貢獻(xiàn)。
Q5:在整個(gè)開(kāi)發(fā)進(jìn)程中,您和您的團(tuán)隊(duì)遇到過(guò)哪些技術(shù)上或其他方面的難題?這些難題又是如何被逐一解決的?在這些難題被解決的過(guò)程中,您總結(jié)了哪些寶貴的經(jīng)驗(yàn)or教訓(xùn)?
我們的合作伙伴,是十多位資料同事和上百位來(lái)自不同團(tuán)隊(duì)甚至是不同公司的開(kāi)發(fā)同事,如何在社區(qū)提供高質(zhì)量的文檔真的不是一件容易的事。
舉一個(gè)很小的例子來(lái)說(shuō),僅是文檔中的圖形就可能有各種顏色和風(fēng)格。為了幫助眾多的開(kāi)發(fā)者撰寫(xiě)合格的文檔,我們的資料團(tuán)隊(duì)組織了社區(qū)寫(xiě)作賦能線(xiàn)上課程、推廣社區(qū)寫(xiě)作模板和規(guī)范;我們也和資料團(tuán)隊(duì)一起,參與原稿案例推廣和宣傳。
針對(duì)社區(qū)文檔類(lèi)型多,格式比較亂的問(wèn)題,資料團(tuán)隊(duì)有計(jì)劃地對(duì)文檔進(jìn)行純凈 markdown 格式轉(zhuǎn)換。一開(kāi)始在 Gitee 提交文檔和翻譯的時(shí)間比較長(zhǎng),閉環(huán)率較低。通過(guò)各種數(shù)據(jù)輔助分析,我們也想了很多辦法,比如有效地識(shí)別同一文檔的 Issue 合并處理,提升處理效率和閉環(huán)率。
生態(tài)的繁榮離不開(kāi)廣大生態(tài)伙伴、每一位開(kāi)發(fā)者的共同努力,每一個(gè) Issue、PR 都是構(gòu)建生態(tài)繁榮的養(yǎng)分。所以我們的小目標(biāo),就是要把這一磚一瓦搭建好。
Q6:加入OpenHarmony生態(tài)以來(lái),您最大的驚喜是什么?或者有哪些具體的收獲?
加入 OpenHarmony 生態(tài)以后,最大的驚喜是開(kāi)闊了眼界,學(xué)習(xí)到了更多的知識(shí)。
傳統(tǒng)的文檔反饋機(jī)制,是通過(guò)官網(wǎng)在線(xiàn)反饋文檔問(wèn)題、等待文檔工程師確認(rèn),再周期性更新發(fā)布。基于 Gitee 的開(kāi)放式討論和 Issue 反饋機(jī)制,使文檔更新更及時(shí)。
我們最大的收獲就是,依托 SIG docs 為 OpenHarmony 提供翻譯和本地化服務(wù),提供了更為豐富的文檔和更為有效的反饋和處理機(jī)制,幫助全球開(kāi)發(fā)者更加輕松、愉快地使用 OpenHarmony。我相信后續(xù)我們還可以更多地利用工具來(lái)提升一些效率,SIG docs 會(huì)越來(lái)越好。
Q7:您期待未來(lái)OpenHarmony哪些方面能夠得到改善、提供更多支持?
作為一名文檔工作者 & 技術(shù)小白,我的關(guān)注點(diǎn)可能更多還是在資料方面。
我希望我們的資料可以根據(jù)不同的讀者進(jìn)行分層,比如小白級(jí)(可以提供一些科普文檔,類(lèi)似深圳衛(wèi)健委公眾號(hào)那樣的)、初級(jí)開(kāi)發(fā)者、高級(jí)開(kāi)發(fā)者;入口清晰,更為體系化。
我們整個(gè)體系的術(shù)語(yǔ),感覺(jué)還可以再完善再清晰一些。很多時(shí)候,術(shù)語(yǔ)就像一條鏈接各個(gè)子系統(tǒng)的脈絡(luò);如果術(shù)語(yǔ)這個(gè)脈絡(luò)做得好,會(huì)非常方便初學(xué)者上手。同時(shí),如果能有更多動(dòng)手體驗(yàn)方面的嘗試,就再好不過(guò)了。
我們衷心希望 OpenHarmony 能吸引到更多的開(kāi)發(fā)者,后續(xù)我們能有機(jī)會(huì)提供更多語(yǔ)種的服務(wù)。
Q8:OpenHarmony目前仍處在開(kāi)發(fā)探索階段,很多共建單位和生態(tài)伙伴還不清楚開(kāi)源項(xiàng)目的玩法,或不知該如何著手進(jìn)行開(kāi)發(fā)。可以請(qǐng)您給大家分享一條,您認(rèn)為最值得分享的心得,或最想說(shuō)的一句話(huà)嗎?
我最想說(shuō)的是,Do it 永遠(yuǎn)比 Say it 更重要。歡迎大家一起來(lái)開(kāi)源共建,OpenHarmony 是一個(gè)開(kāi)放、共享的大舞臺(tái),加入我們,你也有機(jī)會(huì)成為閃耀的代碼貢獻(xiàn)之星!
Q9:請(qǐng)問(wèn)您還有什么話(huà)想告訴大家?
我非常幸運(yùn)能從事我喜歡的工作,更是非常非常地幸運(yùn)能夠加入 OpenHarmony 項(xiàng)目,能在這種大環(huán)境背景下,貢獻(xiàn)自己的微薄之力,我覺(jué)得是我平凡的職業(yè)生涯中很幸福的一件事。
從 2020 年到 2021 年,我見(jiàn)證并參與了 OpenHarmony 的成長(zhǎng),也對(duì)未來(lái)充滿(mǎn)希望。我希望能有更多的開(kāi)發(fā)者加入我們,一起為 OpenHarmony 做出自己的貢獻(xiàn)。
總結(jié)
以上是生活随笔為你收集整理的王莉:将开发文档英文化和本地化,我们努力让OpenHarmony走向全球的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: iOS开发技巧,细节(二)
- 下一篇: mkcramfs 命令学习