脱Excel!Antoraを使った仕様書の作成

こんにちは!とあるサラリーマンのとあるです。

今日は、仕様書の作成に、Excelを使わずAntoraを使うようになった話をしていきますね。

まずはAntoraとはどういったものかを説明し、使うようになった理由を話していきますね。

Antoraとは

Antora」とは、AsciiDocを使って書いたドキュメントのサイト構築ツールです!

Asciidocは、軽量マークアップ言語の一つで、シンプルな記法で技術文書やレポートを記述できるフォーマットです。マークアップ言語で有名なのは、MarkDownですが、より高度な機能を備えています。

このツールを使って、仕様書を作成し、専用のドキュメントサイトを構築して利用するようになりました!

ExcelではなくAntoraを使う理由

僕は、社内向け情報システム部に所属し働いています。

日々の業務で、パソコンやサーバーなどのトラブル対応や運用方法を文書化し部内で共有する必要が発生します。我が社も漏れなく、何でもできるExcel!を使用して文書を作成しています!(笑)。

Excelは突き詰めたら見栄えの良い文書を作成できる良いツール何ですが・・・。

以下にAntoraを使うようになった理由を述べていきますね!

書き方を統一できるから

Excelってマス目上のセルにすれば、レイアウトって自由自在ですよね。嬉しい事なんですが、自由過ぎて自分自身でも過去の書き方と変わるんですよね(笑)

あと見出しのフォントサイズや書き出し位置等は自分で指定して行くので、その時の気分で過去の文書と違っていたりするんですよね。ましてや人が違えば様々な書き方になりますよね。

書き方はこのように統一しよう!ってなっても、1年後にはバラバラになりました(笑)。その点、マークアップ言語で作成すれば、良くも悪くもレイアウトや見栄えは統一できます。仕様書はやっぱ統一感が欲しいですもんね。

関連情報に素早くアクセスできるようになるから

Excelで作成する場合、ある程度の大きさで作成しますよね。1つのBookに何十ものSheetで作成するのはつらいじゃないですか。

となると、関連情報が違うBookに存在する事になりますよね。そうなると、Bookの参照リンクを貼ったりする必要がありますが・・・。面倒すぎてしないですよね。

例え関連情報のBookがわかっていたとしても、NASやファイルサーバーに保存されているので、開くのが遅いですよね。その点、Antoraでドキュメントサイトを構築すると、実質Webページのリンク参照となるので素早く開け、リンクを貼るのも簡単です!

ペーパーレスが推奨されるようになったから

Excelで作成する理由の一つとして、印刷して見てもらう資料作成ツールとして優秀だからもあると思うんです。

社内の印刷資料って、図を使うよりは、表を多く使って且つ、余白は少なくしたペラ1ページが喜ばれるじゃないですか?印刷代も減るじゃないですか?

Excelは改ページやマス目セルを使って実現できちゃうんですよね。

印刷資料の作成ツールとしては、やはりExcelが最強だと思うんですよね。メンテナンスが大変ですけどね(笑)。昔は印刷資料を会議室で確認しながら打ち合わせしていたんですけど、会社の方針としてペーパーレスが推奨されるようになったんですよね。

デスクトップパソコンとは別にノートパソコンも支給されるようになりました。とゆう事で、印刷しなくて良いんだったら、もうマークダウン文書で良いよねってなったんです。

Antoraを使ってつらいと感じた点

直観的に作りづらくなる

見たままに編集できることを WYSIWYG (What You See Is What You Get)って呼ぶんですけど、Excelは正しくWYSIWYGで直観的で作りやすいんですけど、AsciiDocで作成するやり方はそうじゃないんですよね。

貼り付ける画像は1つ1つ別ファイルとして管理するとか、文字を大きくする時は、所定の記号文字を挟まないといけないとか・・。

あるテーマのドキュメントを作成するとして、Excelでは1Bookで済むところを、Antoraだったら複数のフォルダ構造、複数のファイルで構成される1フォルダで管理するって感じです。

あと、作成した文書はドキュメントサイトとして公開するには、幾つかの作業が必要なんです。ある程度自動化しているんですけど、新しいテーマのドキュメントを作成する際は、そのテーマドキュメントに対しての自動化設定作業をする必要があったり・・。

運用コストが増加する

上記に述べた通りメリット、デメリットがあるので、全ての文書作成をExcelからAntoraに乗り換えないです。となると、教育コスト、維持コストが増加するわけですね(笑)

まとめ

要は使い分けですね。仕様書と多くの人に見てもらうドキュメントはAntoraで作成し公開してゆく、等。知見も深まれば、デメリットも軽減されていくと信じて、使っていこうと思います!

コメント

タイトルとURLをコピーしました