ライティング力向上!テクニカルライターが見て良かった動画 -1年間のまとめ- 【Part2】

ブログのアイキャッチ画像

こんにちは!テクニカルコミュニケーションチーム(以下、TC)の原嶋です。
さてさて、先日公開したPart1の記事では、TCで海外の動画を見るきっかけや勉強会の効果などを紹介しました。 このPart2では、この1年で見た動画18本の中から、TCメンバーの澤井、小野、仲田のお気に入り動画を紹介していきます。
ドンドンパフパフ~🎉

この記事は、ライティング力向上!テクニカルライターが見て良かった動画 -1年間のまとめ- 【Part1】の続きです。

動画1:共感のその先へ。ドキュメントのアクセシビリティ

Garoonのヘルプサイトを担当している澤井です。私からは、GoogleのテクニカルライターであるAlexandra WhiteさんがWrite the Docs Portland 2020で発表した"Moving beyond empathy: a11y in documentation"という動画を紹介します。

www.youtube.com

Whiteさんは自らの肩書きを"Accessibility advocate"とするくらいアクセシビリティの取り組みに力を入れている方で、自分で作ったスタイルガイドをGitHubで公開しています。この発表では、Webサイト制作時、アクセシビリティの観点ではどのようなことに気をつけるべきかについて、具体的な失敗例なども紹介しながら説明しています。非常に多くのポイントに触れているのですべては紹介できないのですが、個人的に参考にして、記事作成時などに思い出すようにしているのは、以下の点です。

  • jargon(ジャーゴン;業界用語、専門用語)を使わない

    自分も最初は理解できなかった jargonでも、慣れてしまえば当たり前のように使ってしまうこと、ありますよね。Whiteさんは動画の中で、読者に分からない言葉を使うのであれば、意味を定義して、見えるところに用語集を置くと良いと述べています。
    私はこの動画を見たあと、自分の担当しているヘルプサイトにも用語集のセクションを作りました。

  • 色のコントラスト比などの数値だけを基準にしない

    2つの色を使うとき、コントラスト比の数値を見て、数値だけで「大丈夫」と判断してしまいがちですが、数字上は基準をクリアしていても、色の組み合わせなどで見にくくなっていることもある、という例が紹介されていました。利用者の意見を聞き、使いにくいところがないか、つねに確認する姿勢が必要という言葉はとても参考になりました。

  • ライターが自分で支援技術を使ってみる

    スクリーンリーダーなどの支援技術を自分で使ってみることを推奨していました。サイボウズの開発本部にはアクセシビリティを専門にするチームがあり、ときどきスクリーンリーダー講習会などで教えてもらう機会があります。しかし、書く段になると忘れてしまっていることがけっこうあります。。あらためて、さまざまな読み手を意識し、知識をアップデートしながら書かなければいけないと考えさせられました。

英語表現にも印象的なものがありました。たとえばアクセシブルなドキュメントやプロダクトを作るために必要な心構えとして"It takes a village."と話しています。これはもともとは"It takes a village to raise a child.(子供を育てるには村が必要)"というアフリカの格言から来ていて「何かを成し遂げるにはみんなの力が必要だ」という意味で使われる表現のようです。

Whiteさんはこの表現に続けて「テクニカルライターだけの力でアクセシブルなドキュメントを作ることはできず、デザイナーやエンジニアの協力が必要。テクニカルライターは、自分のリソースを提供したり、専門知識を学んでally(アライ:ここではアクセシビリティの支持者)となることで貢献できる」と話しています。

このように、必要な知識・テクニックだけでなく、アクセシビリティを組織として実践するために必要なマインドセットにも触れられており、とても学ぶところが大きい動画でした。また、こういった動画は一人で見るよりも、大勢で見て感想を言い合ったりすることで、より実践につなげやすくなるように感じました。アクセシビリティについては、これからもチームをあげて、継続的に学んでいきたいです。

動画2:Webライティングにおける最大の間違い

TCチームで、翻訳関連の作業を担当している小野です。私は、今年の4月に育児休暇から復帰し、英語のライティングやチェックをするので、英語の勉強も兼ねてこの勉強会に参加させてもらっています。 私からは、動画2と動画3でNielsen Norman Groupの動画を紹介します。

まずは、記事を書くときに多くの人が犯してしまうミスについて解説した"The Biggest Mistake in Writing for the Web"という動画を紹介します。

www.youtube.com

ズバリ、このタイトルへの答えは、「読み手がどんな人かを分かっていないこと」だと述べられています。 書き始める前に、次の3つの質問に対する答えを考えてから始めると、読み手のニーズに合ったコンテンツを提供できるそうです。

  • 読み手は誰?
  • 読み手が知りたい情報は何?
  • あなたはなぜその記事を書くのか?

誰のために書いているのかを正しく理解して、読み手に合わせて内容を整えるのがUXライティングの肝だと述べられていました。
まず、読み手を把握することで、私たちライターが持っている知識とのギャップがどの程度か確認したり、専門用語を使っても伝わるかどうかを検討します。 そして、読み手が欲しい情報が何なのかを確認することで、適切なフォーマットで記事を書いたり、記事を置く場所を検討できるようになります。 最後に、自分たちが伝えたいことを確認して、読み手にどうなってほしいか、何をしてほしいのかを洗い出しておきます。

これらの検討が記事執筆時のゴールになるので、明確にしてからコンテンツを作成すると、読み手にとっても、私たちライターにとっても嬉しいコンテンツになりそうです。

動画3:Webサイトリンクのためのより良いラベル:クリックを促すための4つのS

動画3では、効果的なリンクのラベルの書きかたについての"Better Link Labels: 4Ss for Encouraging Clicks"という動画を紹介します。

www.youtube.com

この動画では、「見つけやすく、アクセスしやすい」リンクのラベルを書く際に意識したい「4つのS」を紹介しています。

  1. Specific(具体的に)
  2. Sincere(偽りなく)
  3. Substantial(中身がある)
  4. Succinct(簡潔に)

この4つの指針を見ただけでも、大体は理解できるかもしれませんね。私からは3つめの「Substantial(中身がある)」と4つめの「Succinct(簡潔に)」について、どういうことなのか補足しますね。

リンクというのは、周りのテキストとは体裁が違っていて、青字で下線が引かれたりしていることが多いですよね。そういったことから、読み手は周りのテキストはじっくり読まなくても、リンクのラベルはしっかり見る傾向があります。そんな場合でも、リンクの内容だけを見て、適切にユーザーがページを移動できるようにしてあげることが重要です。そのために「Substantial(中身がある)」リンクラベルを書く必要がある、ということでした。

4つめの「Succinct(簡潔に)」ですが、一番最後にしたのには理由があって、先に挙げた3つのSとのバランスを取る必要があるからだそうです。簡潔にしてリンクが読み手が期待するものになっていれば良いですが、リンクは語数が決められているわけではありません。もし、少し長くなったとしてもユーザーが期待する内容にすることが大事です。 とはいえ、最初の数単語で読み手がそのリンク先の内容をつかめるようにすることは特に重要であることは間違いありません(特に英語の場合)。

私が紹介した2本の動画は、どちらもウェブコンテンツを執筆する際に指針となるヒントが数分程度の動画で簡潔にまとめられていました。 特に「4つのS」などは覚えられそうですし、覚えられればいつでも頭の中の引き出しから取り出して、執筆の際に照らし合わせてチェックすることができますよね。 このような指針は、シンプルですが、知っているのと知らないのとではアウトプットに格段の差が出てきそうです。 ウェブコンテンツの執筆だけでなく、オンラインでのコミュニケーションが広がってきている今、普段の仕事上のやりとりなどでも、相手に話を分かりやすく伝える方法として重宝するかもしれないですね。 実際の動画では、例を挙げながら説明している場面もありますので、興味がある方はぜひご覧になってみてください。

動画4:スタイルガイドを一から作る ~ 一人のライターが得た教訓 ~

チームリーダーの仲田(@naoh_nak)です!私からは、Deanna ThompsonさんがWrite the Docs Portland 2021で発表した"Building a style guide from the ground up: lessons learned from a lone writer"という動画を紹介します。

www.youtube.com

「スタイルガイドが無いと、ドキュメントの文章表現や言葉遣い、スタイルがバラバラになっていく」のは、テクニカルライターの方には「あるある」な経験ですよね。最初にきっちりスタイルガイドを用意してからドキュメントを作り始めるのが理想ですが、たいていの場合はそうはいきません。そして、一度バラバラになったドキュメントからスタイルガイドを定義していくのは大変な仕事です。 この動画では、そんな大変な仕事にどう立ち向かっていったか、そこから得た教訓が生々しく語られています。とても面白かったのでオススメです。

スタイルガイドを作るのは大変なので、Doannaさんのチームでは、最初はGoogle Developer Documentation Style Guideを使っていたそう。ですが、参考にしていたのは他社のガイドラインなので、当然、下記の点は書かれていません。

  • 自社のブランドボイスの定義
  • 自社のブランドボイスをどう使っていくのか
  • 自社の用語
  • 自社のドキュメントにあるスタイルをどう使い分けるのか
    (たとえば、軽めの注意だったり、重要な警告だったり)

不明な点を残したまま、他社のガイドラインを参考にした結果、自社のドキュメントは一貫性のないものになってしまったとのこと。

そこで、自分のチームだけでなく、エンジニアやマーケティングなど他のチームも使えるガイドラインを目指すため、上記Googleのガイドラインに書き足す形で、自分たちのガイドラインを作り始めます。この決断を、Doannaさんは「車輪の再発明をする必要はない」と話されています。

スタイル作りの進め方は、以下の流れにすると良いとのこと。

  1. ドキュメント全体を見渡して、不統一な部分や、問題を洗い出す
  2. 基にするスタイルガイドにそれが載っているか調べる
  3. 載っていなければ、スタイルガイドに情報を足す

「1.」の不統一の洗い出しでは、次の3つのポイントにフォーカスします。

  • ドキュメントのレイアウト、見た目のスタイル
  • ボイスとトーン(ブランドやサービスの個性)
  • 表記ルール(ボタン名を太字にするか、カッコで囲うか、など)
  • 用語(製品名や製品用語の正しい表記、社内用語や差別用語など使うべきでない用語)

スタイルガイドをどのような形式で書けばいいのかわからない人向けに、The good docs projectのテンプレートが紹介されています。テンプレートに沿って書いていけば、自社のスタイルガイドができるよう。これは超便利!

ほかにも、

  • 普段使っているツールでスタイルガイドを作ったほうがいい。不慣れなツールで作ると、みんな触らなくなってしまう
  • スタイルガイドの作成には時間がかかるので、過大なくらいに時間を見積もっておいたほうがいい
  • エンジニアやマーケティングチームなどの関係者にどう声をかけて、どう巻き込むか

など、スタイルガイドを作ろうとすると悩むポイントについて実践的な知見が紹介されています。

文章表現については世の中に多くの知見が出ていますが、それをガイドライン化して組織に浸透させるためのノウハウはなかなか無いので、必見の動画です!

Part2はここまで。続きはPart3で紹介します!

今回は4本の動画を紹介しました。 紹介した動画では、どれも実例を交えて改善ポイントを明示されているので、なるほど~💡と納得感が高いです。
特に動画3と動画4は日本語字幕でも見れるので、興味のある方はぜひチェックしてみてください。

紹介したい気持ちが強すぎて、気づけば6000文字越えの記事になってきました。
まだまだ紹介したい動画はありますが、続きはPart3で紹介します。お楽しみに!