Mattermost プロジェクト

このページには、Google シーズンの 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 リクエストを作成します。

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

Duration

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

すでにフルタイムで働いているので、このプロジェクトには日中の一部の作業しかできません。勤務時間の短縮に必要だと思われる場合は、より長期のプロジェクトを行うことも歓迎します。