Mattermost プロジェクト

このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。

プロジェクトの概要

オープンソースの組織:
Mattermost
テクニカル ライター:
@anindita_basu
プロジェクト名:
サービス内テキストの確認と調整
プロジェクトの期間:
長時間（5 か月）

プロジェクトの説明

私は 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 サイズの用紙を 1 ページに収め、できる限り短くすることを目指しています。その目的は、実際にこれらの文字列を記述するデベロッパーは、手早く簡単にガイダンスを参照できる必要があるということです。また、それに従うと、すべての画面で一貫した UI テキストが表示されます。

    私から提案するのは、次の 2 つの理由です。（a）文法とスタイルの観点からテキストの内容に一貫性を持たせるため、（b）GSoD の終了後も、UI テキストを記述するときに誰でもすぐに参照できる一連の手順を用意するためです。

  3. テキストを確認して改良する

    #2 で作成したスタイルガイドに基づき、GitHub で文字列を編集して pull リクエストを作成します。

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

所要時間

どれがユーザー向けの文字列であるかまだわかりません（このプロジェクトではこれをレビュー用に提案します）。私は、スタイルガイドの作成に約 3 週間（下書きから承認まで）かかると見ています。この作業は、文字列をシステム文字列またはユーザー向けとして分類しながら、同時に行うことができます。まず、プロジェクトが標準的プロジェクト（3 か月）となり、この期間に可能な限り多くの文字列をレビュー用に担当するという前提から始めることをおすすめします。

すでにフルタイムの仕事に勤めているため、このプロジェクトには日中のみ勤務できることになります。業務時間の短縮により必要と思われる場合には、より長期にわたるプロジェクトも可能です。