ドキュメント作成について思うこと

その他

SIerってお客さんの業務を効率化するシステムを作ってるわけですが、なぜか自分たちの日々の仕事を効率化できてないのは良くあること。

そのうちの一つに、マニュアルなどのドキュメント作成がある。みんなWordやExcelで全部書こうとしちゃう。ツールには向き不向きがあるのに。おそらく、どのPCにもWordは入っているので誰でも参照・編集できるというのと、書くだけなら非常に良いUIというのがあるからだと思う。

過去、Wordで仕様書やマニュアルを書かされてきた身として感じること

  • SVNなどのバージョン管理との相性が悪い
    • 基本バイナリなので、同時編集、マージに難あり。せっかくバージョン管理しても変更内容を容易に確認できない。WordってXMLで保存もできるけど、人間の目で読めたもんではない。
  • 構造とスタイルがごちゃまぜ
    • HTMLとCSSのように、構造とスタイルを分離できない。これを解決するために、テンプレートとマクロを駆使する必要がある。テンプレートでマニュアル用のスタイルを定義しておき、マクロで、ここはパラグラフのスタイル、リストスタイルを適用、というようにする。
    • しかし人間はミスするもの。細かいスタイルのチェックを結局人で行う必要あり。
  • そもそもWordが不安定
    • ちょっと大きなドキュメントになると開くのに時間がかかったり、クラッシュしたり
    • 不可解な現象が発生したり(WORDのバグだろうな)
  • 国際化対応ってできるの？
    • 過去1度、英語バージョンを作ったけどメンテ不能になってるし。
  • 検索性が悪い
    • あれってどこに書いてあったっけ？と思っても即座に分からない

はっきり言って、普段書いているドキュメント作成にはWordは向いていないよ。