操作指南｜最詳盡文件翻譯志願指南

ApachePulsar發表於2022-01-26

作為 Pulsar 社群的一員，想為社群做貢獻卻沒有頭緒嗎？最詳盡文件翻譯指南來啦！Pulsar 中文社群貢獻者並不侷限於貢獻程式碼，撰寫、翻譯文件也可以成為另一種意義上的 Pulsar Contributor！

本次為不熟悉文件翻譯志願工作的小夥伴們帶來文件翻譯貢獻指南，手把手帶你熟悉如何進行社群志願貢獻！

社群翻譯任務型別

當前，社群文件翻譯任務分為三種：

  • Apache Pulsar 官方文件翻譯：主要任務是將 Apache Pulsar 網站上的英文文件翻譯為中文，讓更多中文使用者更加容易閱讀。翻譯平臺使用 Crowdin 進行翻譯提交、管理和稽核；
  • Apache Pulsar 英文部落格翻譯：內容範圍較廣，主要聚焦技術原理、案例等方向，英文文章翻譯在釋放給社群成員翻譯之前，我們均已取得原文作者授權；
  • Apache Pulsar Weekly（週報）翻譯：內容主要聚焦 Apache Pulsar 社群當週的亮點、重要特性、重要 bug 修復、活動和新聞、技術博文推薦幾個板塊。

術語庫

為了保證英文術語翻譯的統一，方便大家理解，我們長期以來都在維護與 Apache Pulsar 相關的術語庫，目前術語庫詞條已達 500 餘條。建議在進行官方文件和英文部落格翻譯前，仔細閱讀術語庫，降低後續翻譯審閱工作量。

術語表地址：https://shimo.im/sheets/5jozG...

翻譯流程

參與文件、部落格翻譯工作，簡要步驟如下：

  1. 掃描文末二維碼新增 Pulsar Bot 好友，回覆「志願者」加入 Pulsar 中文社群志願者微信群，在 Translation Library 翻譯內容看板認領（在認領的Issue 上評論留言，並在群內@管理員 Tango 留言 Issue 序號進行認領）
  2. 點選認領的 Issue 任務，根據不同翻譯任務型別進入 Crowdin 平臺或 Google Docs
  3. 註冊/登入自己的 Crowdin 賬號或 Google 賬戶（建議使用谷歌郵箱登陸）
  4. 開始進行 Issue 任務
  5. 任務完成後聯絡管理員進行稽核工作

使用 Crowdin 翻譯技術文件

  1. 請注意，把 Crowdin 圈紅處須設定成如圖所示（突出顯示未翻譯、已翻譯和 Review 後的字串，以及是否顯示中文預覽），方便詳細的分辨需翻譯的內容。

  1. 此處的 ID、Lable 我們一般不翻譯，保留英文。

  1. Crowdin 的翻譯是分段的，所以我們需要提前選定點選所想要翻譯的英文段（如圖左側紅色區域），系統會在右上角（圈紅區域）自動生成預設文字，在藍色區域內輸入我們翻譯的內容。

  1. 文字中黃色內容為預設連結，翻譯時保持原狀即可（可以點選上方黃色區域自動複製或點選左下角紅框內的按鈕進行全文字複製後替換其中的英文）。

  1. Crowdin 自帶翻譯校對區域（如下圖圈紅區域，內容翻譯僅供參考），所以在翻譯過程中大家可以參考此處內容，但須避免“翻譯腔” 。

  1. 如何辨識 Crowdin 需完成的內容：
  • 未翻譯內容為紅色
  • 已經翻譯待 Review 內容為淡綠色，文字為灰色
  • 管理員已經 Review 的內容為綠色，文字為黑色

我們的目標就是把所有的紅色區域全部變成綠色！以上為 Crowdin 的基本操作，你 get 了嘛？

翻譯英文部落格

  1. 開啟認領的 Issue，圈紅部分為文件翻譯的指南：

譯者指南：

  • 請將每段的翻譯一一對應放在相應段落下面，方便稽核；
  • 全文請按照 Markdown 格式進行編寫，包括文章程式碼、標題、超連結、引用等等；
  • 請在文章開頭新增個人簡介。感謝每一位翻譯的志願者，我們希望能讓社群看到你的付出；請在閱讀後將譯者指南刪除。

  1. 請在每段英文下方寫下對應的中文翻譯。3. 完成後在群內同步，編輯將邀請來自 StreamNative 和社群的技術專家對文章翻譯進行審閱。4. 譯者確認審閱意見，定稿。

翻譯 Weekly（週報）

  1. 開啟認領的 Issue 內的文件連結，圈紅部分為週報翻譯指南：

譯者指南：

  • 需向週報內填充的內容有：貢獻者名單、（本週亮點）、重要特性、重要 bug 修復、活動和新聞、博文推薦、結尾的 Pulsar 社群資料幾個板塊；
  • 週報原文來自最新一期的 Pulsar Community Weekly Update，請複製後放在相應的板塊內；
  • 每個部分皆有示例，注意事項請仔細閱讀並參考其中的示例樣式進行編輯翻譯；
    注意事項：
  • 中英文之間需空格；
  • 請在每段英文下方寫下對應的中文翻譯。
  • 博文推薦需集合英文週報內 blog 與本期間微信公眾號上 Pulsar 相關內容；
  • 文件全篇請採用 markdown 格式，以便排版；
  1. 點選右上角編輯模式（Editing）進行翻譯編輯。

  1. 按照文件內圈紅位置示例填充（本週亮點）、重要特性、重要 bug 修復幾個板塊。

  1. 更新活動和新聞模組（此處須放上該周內 Apache Pulsar 公眾號釋出最新的活動、新聞動態內容）如下圖圈紅區域。

  1. 博文推薦模組（如上圖圈藍處需放上該周內週報內博文部分與 Apache Pulsar 公眾號釋出的中文部落格連結）。
  2. 更新結尾的譯者簡介及 Pulsar 社群資料（如下圖圈紅區域）。

  • Contributor 數量更新位置如下圖：

  1. 請更新導語部分的貢獻者名單及該週週報的具體日期（如圖圈紅位置）。
Apache Pulsar GitHub 倉庫在此期間 merged PR 的貢獻者名單，地址：https://github.com/apache/pul...

  1. 完成後請在群內同步，編輯將邀請來自 StreamNative 和社群的技術專家對文章翻譯進行審閱。
  2. 譯者確認審閱意見，定稿。

文件翻譯貢獻制度-積分制

在 Pulsar 社群，為社群出力的方式多種多樣，不只是程式碼的貢獻者，如果你對文件和內容的翻譯整理、活動的組織策劃、社群的運營感興趣，都可以成為志願者的一員。

Pulsar 社群志願者採用積分制，並非是為了比較大家貢獻的多少，而是記錄大家的熱情，方便我們定期為積極的小夥伴們定製獨有的 Pulsar 志願者周邊來感謝你們的付出和熱愛。

目前社群志願者貢獻採用積分制度：定期積分累計清零，將為積分前 3 的小夥伴郵寄一份專屬的定製禮品，詳情參考下方圖片?

志願者積分制度與禮品示意圖

Pulsar 中文社群正在招募文件翻譯志願者，歡迎請掃描下方二維碼回覆「志願者」加入我們，趕緊行動起來吧！



"掃碼新增 Bot 好友"

關注公眾號「Apache Pulsar」，獲取乾貨與動態

相關文章