このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- Mattermost
- テクニカル ライター:
- @anindita_basu
- プロジェクト名:
- プロダクト内のテキストを確認、修正する
- プロジェクトの長さ:
- 長期実行（5 か月）
プロジェクトの説明
Slack チャンネルに参加し、Eric にいくつか質問を送信しました。彼の回答（Eric 様、ありがとうございます）に基づいて、
このプロジェクトには、次の方法で取り組むことを提案します。
文字列を分類する
まず、どの文字列（https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json）がシステム コンソール用で、どの文字列がユーザー向けかを特定します。まずは、ユーザー向けの文字列を確認して確認することをおすすめします。
文字列のスタイルガイドを作成する
メニュー項目、アクション ボタン、ラベル、見出し、ツールチップ、エラー、警告、検証、通知、確認で使用される文字列の大文字、長さ、単語の使用に関するスタイルを定義します（スタイルガイドのスクリーンショットの例: https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG）。また、文字列（特に複合文字列）でトークン（プレースホルダ）を使用する際のガイダンスも作成したいと思います。
このガイドラインでは、A4 サイズの用紙を 1 ページにまとめ、できる限り短くしたいと考えています。意図は、実際にこれらの文字列を記述するデベロッパーは、ガイダンスを迅速かつ簡単に利用できるものにする必要があります。さらに、それに従えば、UI テキストはすべての画面での一貫性を示すことになります。
理由は 2 つあります。（a）文法とスタイルの点でテキストの内容に一貫性を持たせることができる（b）GSoD が終了した後も、UI テキストの作成時に誰でもすぐに参照できる一連の手順が存在する
テキストを確認して改良する
ステップ 2 で作成したスタイルガイドに基づいて、文字列を編集し、GitHub で pull リクエストを作成します。
=============
所要時間
どのくらいの文字列がユーザー向けの文字列であるかは、まだわかりません（このプロジェクトで審査対象とすることを提案しています）。スタイルガイドの作成には、下書きから承認まで約 3 週間かかると見込まれます。この作業は、文字列をシステム文字列とユーザー向け文字列に分類する作業と同時に行うことができます。プロジェクトは標準的な長さ（3 か月）であると仮定して、この期間内に可能な限り多くの文字列をレビューすることを提案します。
私はすでにフルタイムで働いているため、このプロジェクトにはパートタイムでしか参加できません。短時間勤務が必要な場合は、プロジェクトの期間を延長することも可能です。