このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- WordPress
- テクニカル ライター:
- dmivelli
- プロジェクト名:
- WordPress HelpHub ドキュメントの記事の見つけやすさを改善
- プロジェクトの長さ:
- 標準期間(3 か月)
プロジェクトの説明
エグゼクティブ サマリー
WordPress の人気は日々高まっています。2020 年 7 月上旬時点で、WordPress 5.4(2020 年 3 月 21 日にリリースされた最新バージョン)は 5,100 万回近くダウンロードされています。最もよく使用されている言語は英語(71%)で、次にスペイン語(4.7%)、インドネシア語(2.4%)が続きます。
優れた技術ドキュメントは、あらゆるヘルプシステムの基盤となります。経験豊富な技術ライターは、知識をユーザー向けのコンテンツにまとめます。ユーザーは、その時点で有益なアクションや必要なアクションを実行しようとしています。優れた技術ライターは、わかりやすく正確なドキュメントと、ユーザーの立場に立って考える能力が不可欠であることを理解しています。ただし、編集や制作の品質など、技術ライターにとって最も重要な要素は、ユーザーにとってのタイムリーさと見つけやすさよりも重要度が低い場合があります。ユーザーが見つけられないヘルプトピックを作成しても、何の役にも立ちません。
2003 年の開始以来、オープンソース コミュニティで WordPress が成長を遂げ、デベロッパー、ユーザー、コントリビューターが集まっています。元の記事のカテゴリとタグは、WordPress コミュニティの成長と変化するニーズに応じて更新し、モダナイズする必要があります。
ユーザーがリクエストしたドキュメントへのパスがわかりにくい場合や、中断された場合、ユーザーは検索に失敗し、プロダクトに対する信頼を失い、プロダクトを完全に放棄する可能性があります。
解決策があります。見つけやすさを改善し、ユーザーが目的のドキュメントにたどり着けるようにするには、次の方法があります。
- カテゴリ タイトルのスタイルを決定して設定する
- カテゴリのタイトルを評価し、トピックに正しく対処していることを確認する(必要に応じて更新を提案する)
- 記事を確認して、分類が正しいことを確認する
- 各記事のサブカテゴリを定義する
- 検索結果でユーザーがサポート フォーラムに誘導されないようにする
- 重複または古いトピックをメモして削除する
WordPress コミュニティは目覚ましい成果をあげており、この 17 年間の成果を共有しています。分類を更新し、ユーザー ジャーニーを正確にすることで、毎月 7, 000 万件近くの新しい投稿と 7, 700 万件の新しいコメントを作成しているユーザーの成長、成功、ロイヤリティを継続的に高めていきます。
はじめに
作家のジョセフ キャンベルが「ヒーローの旅」という用語を作り出した。フィクションでは、主人公が世界に旅立ち、困難に直面して克服し、変容して帰還するという構造的なコンセプトを指します。
技術ドキュメントの領域では、ユーザーは学習、回答、トラブルシューティングを目標にしたヘルプトピックに誘導する取り組みにも乗り出します。ユーザーがこの目標を達成できれば、すべてがうまくいきます。ユーザーが回答を見つけられないと、不満を感じて離脱してしまいます。
なぜこのようなことが起こるのでしょうか?これは、ライターが手抜きをしている、気にしていない、ノウハウがないわけではありません。多くの場合、技術ライターがユーザー ジャーニーを考慮していないことが原因です。ライターは優れたコンテンツの作成に没頭し、ユーザーがそのトピックにアクセスする方法について考慮しなかったりすることがあります。ユーザーの行動に焦点を当てることが重要です。彼らが何を知りたいのか、どのように到達したいのかを考慮する必要があります。
WordPress コンサルタント兼 UX デザイナーの Estela Rueda に、その歴史について伺いました。現在、一部のタイトルが記事の内容を正確に表していません。カテゴリはタグとして使用されますが、15 年前に作成されたため、一部は古くなっています。タグ付けに一貫性がない。これは、ユーザーが答えを求める妨げとなります。
現在の状態
WordPress サポートは、9 つのメイン カテゴリ(スタートガイド、WordPress のインストール、基本的な使用方法、基本的な管理、カスタマイズ、メンテナンス、セキュリティ、上級者向けトピック、トラブルシューティング)に分かれています。各カテゴリには複数のサブカテゴリやサブトピックがあり、それぞれのサブカテゴリやサブトピックから別の記事に誘導され、各ランディング ページでより多くの情報が表示される可能性があります。
熱心で協力的な WordPress コントリビューターがいるメリットは、多くのトピックを利用できることです。しかし、意見や視点が多いため、タグ付けとカテゴリに一貫性がありません。
これらのトピックを最新のものに更新し、カテゴリが WordPress ユーザーの現在のニーズを満たすようにする必要があります。200 を超える記事が投稿されたため、タグと分類に関する問題が関連性を持つようになりました。
プランの分析
主な目的は、記事を確認して再分類し、検索性を高めることです。次の手順をご案内いたします。
メンター Estela Rueda と連携してプロセスを固める
- これは、詳細を確認して合意するために重要なステップです。
- Estela の指示に従い、提案されたすべての更新をスプレッドシートで追跡します(Estela の経験上、収集してから推奨事項を提案するのが最善であることがわかっています)。
カテゴリ タイトルのスタイルを決定して設定する
- 名詞の形式(インストールかインストールか)ではなく、現在形のカテゴリの統一された一貫した構造を提案します。名前の形式(-ing)は、第二言語(ESL)の英語ユーザーを難しくする可能性があり、-ing はユーザーに価値を付加しないためです。
- カテゴリには、1 語または 2 語の単語(メンテナンス、セキュリティ、基本的な管理など)と、動名詞のフレーズ(WordPress のスタートガイド、カスタマイズ)があります。構造を統一することを検討しましょう。
- 他の組織がオンラインヘルプをどのように設定しているかを調査し、役立つものを探してメンターに相談します
カテゴリ タイトルを評価する(および更新を提案する)
- WordPress のターゲット ユーザーの視点から認識でき、現在のニーズに合っている必要があります。
- 一貫性があり、WordPress スタイルガイドの基準に準拠していることを確認します。
- タイトルで意図を伝える/説明する
- タイトルで、前提条件となる必須操作やユーザー/デバイスの状態を明確に示す必要があります。
記事/トピックを確認する
- トピックは、WordPress のターゲット オーディエンスのユーザーのニーズを正確に満たしていますか?
- トピックは正しいコンテキストを設定していますか?それとも、より大きなシーケンスの一部ですか?
- ステップはタスクにおけるさまざまなアクターを区別していますか(ユーザー、システム/デバイス、誰が何をしているか)?
- 攻撃者は明確に区別されていますか?
- 手順は、複雑なプロセスを実行可能なチャンクに分割していますか?
サブカテゴリを定義してタグ付けする
- ユーザー ストーリーを参照し、今後の参考のためにスプレッドシートに追加し続けます。
- サブカテゴリのリストに追加し、パスを詳細に記述します。
検索結果からユーザーをサポート フォーラムにリンクしないようにしてください
重複するトピックや古いトピックをメモして削除します。このフォレンジック作業は、ユーザー ジャーニーを把握して効率化するために役立ちます。
タイムライン
2020 年 8 月 16 日まで
- WordPress のドキュメントを確認する
- WordPress のドキュメント スタイルに慣れる
- ヘルプトピックへの顧客の流れに関するベスト プラクティスを調査する
8 月 17 日~ 9 月 13 日
- Estela や WordPress コミュニティと交流する
- Estela と連携してプロジェクトのステップを調整し、完了までのマイルストーンを提案する
- マイルストーンと週次タスクを含むスケジュールを作成する
- Estela とのステータス チェックインの頻度を設定します(ブロックをタイムリーに解決するため)
9 月 14 日~ 11 月 30 日
- Estela/メンターとのプロジェクトのキックオフと開発作業
12 月 2 ~ 5 日
- 最終的な成果物レポートを送信する
12 月 3 ~ 10 日
- プロジェクトの成功の評価と、WordPress のメンターやチームとの共同作業経験の評価を提出する
まとめ
WordPress は、最も一般的なコンテンツ マネジメント システム(CMS)です。W3techs によると、WordPress はすべてのウェブサイトの 37.7% で使用されている CMS であり、CMS 市場シェアの 63.6% を占めています。
このような人気を博している WordPress ユーザーの心をつかむには、正確でわかりやすいドキュメントが不可欠です。
WordPress では、ユーザー ジャーニーと、ユーザーのパスに関する質問を考慮して、ヘルプカテゴリとタグ付けを刷新し、質問に効果的に回答し、問題のトラブルシューティングを行うことができます。そうすることで、今後も WordPress が満足のいく顧客を引き付け続けるでしょう。