始めに
個人的なメモをベースに少し体裁を直しています。
システム開発・保守運用でほぼどこでもドキュメントを作成します。会社によって色々なファイル(Excel,Word etc)で作成していますが、これらのファイルは経験上こんな面倒に当たりました。
- いざ目的のドキュメントを探そうとしても見つからない。
- 統一したテンプレートがないから、一からテンプレートを作成する必要がある
- 印刷レイアウトを考えてしまう
- 歴史を重ねると最新の居場所が分からなくなる
Asciidocとの出会い
Wordでテンプレートを作成したり、運用ルールを作ったりしたのですがメンバーが増えると人の数だけ多様性が発生し、レビューでストレスがたまりました。
代替を色々と探し色々と試してAsciidocが現段階で一番楽なのかな？という結論に達しました。
Asciidocの始め方
Asciidocは基本テキストファイルなのでテキストエディタで作成できます。IDEを使うとPreviewを確認しながら作成できるます。Asciidoctorのサイトで調べると以下のエディタがあるようです。
Editing AsciiDoc with Live Preview
VisualStudioCodeを使っている人が多いようですが、個人的にIntelliJを使っています。
VisualStudioCodeのPreviewプラグインは更新の度にページの先頭に飛んでしまい、長文を書くと煩わしさを感じました。
Asciidocの構文
色々と書き方などたくさんあるので都度記事を作成し、ここからリンクを作成していきます。