Mattermost 專案

本頁詳細說明 Google 文件季度接受的一項技術撰寫專案詳細資料。

專案摘要

開放原始碼組織：

案件

技術撰稿人：

@anindita_basu

專案名稱：

查看並修正產品內文字

專案長度：

長期跑步 (5 個月)

Project description

我加入了 Slack 頻道，向 Eric 提出一些問題。根據
他的回應 (謝謝 Eric！)，我提議透過
以下方式處理這項專案：

1. 將字串分類

   我會先找出哪些字串 (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) 是系統控制台，並向使用者顯示。我一開始建議先擷取向使用者顯示的字串來進行審查。

2. 建立字串的樣式指南

   我想為選單項目、動作按鈕、標籤、標題、工具提示、錯誤、警告、驗證、通知和確認訊息中使用的字串定義大寫、長度和字詞用法的樣式 (請參閱 https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG 的樣式指南螢幕截圖)。另外，我想針對字串中使用符記 (預留位置)，特別是複合字串的使用建立指引。

   可以的話，盡量只將本指南引導至 A4 尺寸工作表的一頁。舉例來說，實際編寫這些字串的開發人員應能迅速找到相關指引，而且使用之後，UI 文字在所有螢幕上會保持一致。

   這麼做有兩個原因：(a) 確保文字在文法和樣式方面保持一致 (b) 這樣即使在 GSoD 結束之後，任何人都能在編寫 UI 文字時快速參考一系列操作說明，

3. 查看並修正文字

   根據 #2 建立的風格指南，我將編輯字串並在 GitHub 建立提取要求。

=============

時間長度

我還不知道有多少字串是面向使用者的字串 (這就是我提議在這項專案中審查的字串)。據我估計，建立風格指南可能需要大約 3 週的時間 (從草稿到核准)，這項作業可以同時將字串歸類為系統字串或面向使用者。我提議先假設專案內容會是標準長度專案 (3 個月)，這段期間內我只會盡可能擷取大量字串以供審查。

由於我已經在全職投入了，因此每天只有部分時段能完成這項專案。如果你覺得我的工作時間縮短，我願意參與較長時間的專案。