このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- Collective を開く
- テクニカル ライター:
- Anna e só
- プロジェクト名:
- 一般的なヘルプ ドキュメントを改善する
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
第一印象 メディア（動画、GIF、画像）をサポートしていないドキュメント ページに、対応メディア（動画、GIF、画像）のない説明が記載されていることがよくあります。同じ章の別のセクションには、より詳細なエントリがあります。たとえば、「共同編集」は手順のみで構成され、「Fiscal ホストを追加」には補助メディアが組み込まれています。
閲覧したページで、代替テキスト属性を使用してメディアが記述されていない。画像の説明がないと、スクリーン リーダーを使用するユーザーや、インターネット接続が低速でメディアの読み込みに失敗する可能性があるユーザーが、ドキュメントを完全に理解する妨げとなります。
ドキュメントの一部のセクションには、よくある質問と、UI を操作するための直接の手順がまとめられています（「Fiscal ホストの変更」など）。ドキュメント インターフェースには目次がないため、登録レコードの変更による影響を認識していて、客観的な説明のみを求めるユーザーは、ドキュメントの内容が冗長であまりにも重要すぎると受け取ってしまう可能性があります。
技術ドキュメントの言語には一貫性がありますが、一般公開されているスタイルガイドのドキュメントでは、ドキュメントの記述方法が少なすぎます。[貢献] ページでは、技術ドキュメントへの貢献について言及しているため、Open Collective と潜在的なコントリビューターの両方に、より包括的なガイドラインが役立ちます。
提案 私は、ユーザーのヘルプページを見直し、表示方法や現在の構成を見直すことを提案します。
手法とタイムライン コミュニティと協力して、期間が異なる継続的なフィードバック サイクルを促進することで、Open Collective のドキュメントを改善したいと考えています。
コミュニティの絆を深める期間（2019 年 8 月 1 日～ 9 月 1 日）：Open Collective コミュニティについて知る著名な開始プロジェクトのアクティブなメンバーにインタビューし、ドキュメントの現状について質問します（レポート #1）。問い合わせと問題を追跡するために使用されているすべての内部システムと、それらを Open Collective ドキュメント（レポート #2）に文書化するプロセスを記録します。現行版のドキュメントの潜在的な問題点の評価と、それらを解決するための計画の作成（レポート #3）。
9 月 2 日～ 6 日: 最初のフィードバックと調整のサイクル。コミュニティの絆を深めた期間中にコミュニティから寄せられたすべてのコメントと提案を考慮。この計画はうまくいっているでしょうか？変更が必要な点はありますか？（レポート 4）
9 月 9 ～ 20 日: ドキュメントの人口が少ない章で概念実証を実施。公開されているスタイルガイドのドラフト（レポート #5）
9 月 23 ～ 25 日: 評価のための概念実証の提出（クローズド グループ）。
9 月 26 ～ 27 日: 概念実証を実施する前に調整を加える必要はありますか？もっと時間が必要ですか？必要に応じて調整します。（レポート #6）
9 月 30 日～ 10 月 9 日: 概念実証を公開。フィードバックの 2 サイクル目（公開グループ）。
10 月 10 ～ 15 日: 最終的な概念実証の評価と調整のサイクル（レポート 7）
10 月 16 日～ 20 日: 活動を小休止します [1]。
10 月 21 日～ 11 月 23 日: 公開スタイルガイドが最終版（レポート #8）スタイルガイドに記載されているすべての手順を、すべてのユーザー ドキュメント ページに適用します（レポート 9）。実施したすべてのアクティビティを評価し、コミュニティに対するさらなる推奨事項を報告します（レポート #10）。
プロジェクトの期間はリクエストに応じて延長される場合があります。
[1]: 旅行がドキュメント シーズンになる前に予定されています。
成果物 - 実施したアクティビティに関する 10 件の公開レポート - Open Collective と外部の寄稿者の両方が使用できる公開スタイルガイド - ユーザー ドキュメント ページの刷新