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 個月)，並在這個時間範圍內，只審查我能處理的字串數量。

由於我已就業全職，因此只能在白天部分時間處理這個專案。如果你認為縮減的工作時間需要較長時間，可以申請進行較長時間的專案。