テクニカルライティングを展開してみた

ドキュメント テクニカルライティング

こんにちは。インフラ部門でマネージャをしておりますさたかです。先日、部門内で実施している技術向上の活動にて、テクニカルライティングに関する取り組みを実施したので、実施した背景や実際したことについて書いていきます。

実施に至った背景

以前、弊社エンジニアブログに投稿した記事に書いたDiv技術向上というインフラ部門の活動において、ドキュメントを書く文化を醸成しようという取り組みを実施しました。 具体的にはドキュメントを書く意義や利点などを啓蒙しつつ、作成状況を可視化・共有するといった内容です。 Div技術向上は各チームのメンバーが一人は参加しているワーキンググループ（以下、WG）で、チーム内でも啓蒙活動をしていただいた結果、 順調にドキュメント作成数は増えていき、何かあればドキュメントを書くというレベルにまでなってきた感触を得ていました。

そこで次なる取り組みを検討していた際に、今度は量ではなく質に目を向けてみようとなりました。 優秀なエンジニアは質の高いドキュメントが書けることも大事だという話が出たからです。 実はその頃、自身が作成したドキュメントを見た時や他者が作成したドキュメントをレビューをしている時にふと下記のようなことを感じることがありました。

  • 5W1Hがはっきりしていない
  • 冗長な表現になっており意味を理解するのに時間がかかる
  • 対象となる読者が誰なのかわからない

上記の項目を満たしている品質の高いドキュメントがある一方で、どれかの項目がうまく表現できていないドキュメントもあり、品質にばらつきがありました。 書く対象にしている分野が報告資料なのか検証記録なのかなどの違いによってもドキュメントの質にばらつきが出ており、品質を向上・均一化していくにはどうしたらいいかなと考えていました。

そういったこともあり自分自身としてもドキュメントの質向上の取り組みは大賛成でした。 具体的に何を実施するかという話になった時に出てきたキーワードがテクニカルライティングでした。

テクニカルライティングとは？

私が調べた中でしっくりきた意味としては「正確かつ効果的に伝達するための文書作成技法」です。 まさにドキュメント作成において重要な部分であり、これが出来るとかっこいいなぁと感じました。 WGのメンバー内からも取り組みに前向きな意見が多くあがり実施することが決まりました。

やったこと

まずはDiv技術向上のメンバーでテクニカルライティングについての調査を実施しました。 主に以下のようなドキュメントがありました。

その他様々な企業の資料を拝見し検討した結果、サイボウズ社の資料が新入社員向けに作られており、内容が理解しやすいかもねという話になりました。

部門内の展開方法についてはWebミーティングツールの画面共有機能を利用して、参加者全員で動画を視聴する形式で実施しました。 実は実際の研修動画が公開されており、自分たちで読み上げるより効率的だと思ったからです。 また、内容について振り返れるように動画視聴後に4人1組で意見交換会も実施しました。 意見交換会に関しては各組にWGのメンバーがファシリテータとして入ることで活発に議論できる雰囲気作りも意識しました。 私が担当した組では「勉強になった」「実技もやってみたい」といった話が出ていました。

やってみて

動画視聴に関しては時間の都合もあり当初1.5倍速で動画を流したものの、ちょっと早いと感じる人もいたため最終的には1.25倍に落ち着きました。 また実施後アンケートを取ってみましたが、非常にポジティブな意見が多くみんなドキュメントの質向上に興味があったんだなということがわかりました。 アンケートに書かれていた主な意見は下記の通りです。

  • よいドキュメントがよりよい運用チームを作るため
  • かかる労力が小さい上にメリットが大きいと感じたため
  • 情報が整理されていると読む側も理解しやすくなると思った

これは実施した側としてはとても嬉しい反応でした。WGのメンバーも「今まで一番反応が大きかったのでは？」と話していた程です。

まだ展開を実施したのみで部門内のドキュメントの品質に変化が現れたかは見えていないのですが、変化をどうキャッチアップするかについて考えるのも取り組みとしては有意義かなと思っています。

感じた事

インフラ部門では各チームごとに取り扱う技術分野が違うため、技術的な内容で研修を実施しようとすると ターゲットを決めるのが難しかったのですが、ドキュメント作成についてはどのチームでも共通で発生する業務のため 多くの共感を得られたのではないかと感じました。また、インフラ部門では社員向けのユーザーマニュアルも作成しているため テクニカルライティングによるドキュメントの質向上は会社に対する貢献にもつながると考えています。

今後

今回は動画視聴のみだったため、次回は実技も交えて研修を実施したいと考えています。 また、ドキュメント作成時やレビュー時にテクニカルライティングが活用出来ているか確認するための テンプレートといった仕組み作りもしたいと思っています。