ヘルプサイトの作り方』(仲田尚央、山本絵理・著、技術評論社)を読んだ。
タイトルにあるように、ソフトウェアといったプロダクトのヘルプを作成する方法を解説している。事例としてサイボウズ社のヘルプサイトも登場する。
目次は上記リンク先から確認できる。



たとえば第6章「記事を作る」では、執筆時に使える手法が具体的に解説されている。文の書き方(例:一画面一手順)や図解の方法(例:ユーザーの視点から描く)などである。
こういった内容はもちろん参考になるが、ライティングの教本などほかの書籍でも取り上げられていることもある。
やはり本書で独特なのは、ヘルプの書き方というより、ヘルプサイトを全体としてどううまく作るかを扱っている点だと思う。
第1章の冒頭にもあるように「文章力」より「設計力」に注目しているのである。



個人的には、翻訳支援ツールと連携したサイボウズのヘルプ管理システムの話が面白かった。
以前、自著に関連してサイボウズを取材させてもらったことがある(記事)。サイボウズでは対訳用語集を自社製品で管理しているという話だったが、ヘルプ管理システム全体としてどう動いているかまでは知らなかった。
本書ではその全体像が(ページは少ないものの)説明されている。以下、173ページから図を引用する。

978-4-297-10404-7_p173

フローとしては、まずヘルプの記事を制作して「GitHub」に取り込んでいることがわかる(図上半分)。
その後、記事を「翻訳支援システム」に渡している(図下半分)。実際の翻訳は、その右側にある翻訳者と「機械翻訳」が行う。その際に左側から「用語」を取得しているのだ。ここで対訳用語集が利用されているということだ。
記事の翻訳が完成するとGitHubに戻し、その後ヘルプとして公開される。

やはりITはアメリカ企業が強く、ヘルプを多言語化している国内IT企業はそれほど多くないように思われる。そのため多言語化のフローはとても参考になるし、事例を提供してくれるサイボウズは貴重な存在である。



なお、第5章「スタイルガイドや用語集を準備する」で、日本語スタイルガイドとして「JTF日本語標準スタイルガイド」を紹介していただいている。
制作に関わっている者として感謝申し上げたい。