intellista

engineer's notes about application development, data analysis, and so on

わかりやすいマニュアルや記事を書くには?


わかりやすくマニュアルや記事などを書く技術についてのLIVE配信を視聴しました。かなり得るものがあり、感謝しています。
配信のアーカイブ動画を貼ります。2時間ほどありますが、再生スピードを変えられるので時短できそうです。
www.youtube.com

「2時間はキツい」という場合は、スライドでチェックしても良いかもしれません。登壇者2名の方のスライドが公開されています。これでわかれば超時短です。

セッション1

speakerdeck.com

セッション2

speakerdeck.com

個人的に為になったポイント

個人的に為になったポイントのトップ3は、次の点です。

  • 記事の構成要素は、タイトル、概要、本文。
    • タイトルと概要をつける。そうすると読者が何の話か把握できるため、本文を読んでもらえる。
    • タイトルは問題や結論を簡潔に書く。タイトルが長すぎると概要になってしまい、タイトルとしてはわかりずらい。
  • 「名前を大切にする」のトピックで解説された、文章のわかりにくさの正体と改善方法
  • テクニカルライターという職種の存在

このブログも改めて見ると課題が浮き上がりました。反省とともに新鮮な気持ちになりました。

その他

セッションの中で、次の書籍が有用と紹介されました。ガイドラインとしてお薦めだそうです。使っている視聴者の方もいました。

日本語スタイルガイド(第3版)

YouTubeLIVEなので、残業で見られなかった前半部分を終了後に視聴できました。アーカイブ動画があるのはありがたいです。1.5〜1.75倍速くらいで確認できたのも時短になり助かりました。質問できない点を除けば、メリットが大きいと思いました。

なお、この配信はコンパスから申し込みました。LINE社は精力的に開催しているようです。今回のテクニカルライティングについては初回とのことで、良かったので次回4/15も申し込みました。楽しみです。