このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソースの組織:
- OpenMRS.org
- テクニカル ライター:
- marslan8530
- プロジェクト名:
- 既存のウィキをレビューしてリファクタリングし、ユーザー プロフィール主導型に変更
- プロジェクトの長さ:
- 標準期間（3 か月）
プロジェクトの説明
OpenMRS Wiki ページに移動するたびに、高密度でコンパクトな情報メニューが表示されています。このメニューに慣れていて、長い間使用しているユーザーにとっては問題ないかもしれませんが、新しいユーザー、特に技術者以外のユーザーにとっては問題になります。6 月 27 日のオンライン ミーティングでは、昨今の人々は非常に多忙で、非常に短い時間で何を求めているのかを指先で手に入れたいということも強調しました。私たちはこうしたものを見過ごしています。情報アーキテクチャを理解し、Wiki 内に基本原則を実装する必要があります。ベンチマークというプロセスがあり、Google の進捗状況を業界トップの企業と比較します。同様に、OpenMRS の Wiki ページを他の評判の良い組織の Wiki ページと比較して、OpenMRS の Wiki の改善点を見つける予定です。ただし、最初に解決すべき問題は次のとおりです。
- 非常に密集しており、削除できる関連性のない情報が多数含まれている。
- OPENMRS とは何ですか？冒頭に適切な導入文がありません。
- 画像と余白は常にユーザーを引き付けます。ホーム画面に画像を追加する必要があります。最近の写真が絶えずシャッフルされて表示されるのかもしれません。
- [詳細] というオプションがあります。これは必ず使用する必要があります。何かに関する情報をすべて最初から貼り付ける必要はありません。プレビューを提供するだけで、興味を持ったユーザーはさらに詳しく調べることができます。
- 左側のメニューを改善する必要があります。技術に詳しくないユーザーが求める情報はほぼすべて含まれていますが、見づらく、コンパクトです。
- 家庭のテーブルの配置が不適切です。これらのタスクは別のタブで管理し、左側のメニューに追加できます。これにより、プロジェクト中に議論して検討する関連性の高い情報のためのスペースが空きます。
- また、技術者以外のユーザーが持つ意味についても話し合う必要があります。コーディングやエキスパート ナビゲータに精通している必要はありません。最初は基本情報、下に行くほど詳細な情報が表示されます。ウィキページを主要なチャンクに分類し、視聴者が探している情報がどのタブにあるかを簡単に予測できるように、そのようなキーワードを事前に使用する必要があります。