Mattermost 專案

本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。

專案摘要

開放原始碼機構：

Mattermost

技術文件撰寫者：

@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 個月)，但在這個時間範圍內，我只能參考許多字串以供審查。

由於我已全職工作，因此我每天都能夠參與這項專案。如果您認為減少的工作時間需要縮短，我願意加入較長時間的專案。