Asciidocとは
Markdown記法のように記述していくとドキュメントが作成できるようなものです。
例えば、見出しを書く場合は、
== 見出し1
=== 見出し2
のように書くことが出来ます。
Asciidocを使用した理由
新製品をリリースするにあたり、マニュアルの整備が必要となり私がその業務を担うことになりました。
初めてマニュアル作成を行うので、作成したことがある人に作成方法を周りの人に聞いていたら、
"あんなの二度とやりたくない！"
"wordをpdfに変換して、見出しやらページ数やら自分でつけるのがダルい"
"見出しやページの確認作業が人海戦術のためミスが多発する"
などなど、かなり否定的な意見が出てきましたので、効率がよく、作業性の高いツールはないかと探していたら、
Asciidocにたどり着きました。(最初はMarkdown記述で行っていました。)
物は試しという事で、軽く使ってみたのですが、非常に使い勝手が良かったためAsciidocで作成してみることにしました。
Asciidocの何が良いのか
- 自動生成
目次やページ数が自動生成されるのが非常に楽です。
また、
asciidoctor-pdf filename.adoc
と、コマンドラインで打つだけでpdfに変換してくるため、複数のwordファイルをpdfに変換し、pdfを結合するという作業がこのコマンド一つで完結してしまいます。
弊社では、Wordを使用しており、
"wordをpdfに変換して、見出しやらページ数やら自分でつけるのがダルい"
という面倒な点を回避できたことから、マニュアル作成者に非常に好評です。
私自身、今回の業務でマニュアル作成をしていることもあり有用性を感じています。
同期にも展開してその使い心地を体感してもらっていますw
- リアルタイムプレビュー
実際に書いたものが、どう成果物として現れるか確認できるのも非常に良いです。
しかも、それをhtmlやpdfに変換してもプレビュー通りの見た目になるので、余計な修正の手間もかからず便利です。
なんかプレビューするとズレるんだけどーって事も今のところないので良き。
- 自由度
Wordだと、見出しを作成したり、強調したい部分はフォントサイズを変更する。という場合が多いかと思いますが、
Asciidocでもそれは可能です。
こんな感じです。
*強調したい*
フォントサイズは一律ですので、強調したい部分が複数あってもフォントのズレはありません。
Wordでは良くも悪くも自分でフォントサイズを指定できるため、最終リリース前にフォントサイズがずれてますよ！
って指摘が良くあるらしいので、それは防げるかなぁと思っています。
まとめ
まとまりのない文章でしたが、ここまで読んでいただき、ありがとうございました。
今後少しずつ自分で得た知識のアウトプットをしていきたいと思います。