RedPen、Asciidoctorを使ったドキュメント作成システムの構築が面白そう

ドキュメント作成の世界にもアジャイル開発の波が押し寄せてきているのでしょうか。「ドキュメント作成システム構築ガイド[GitHub、RedPen、Asciidoctor、CIによる モダンライティング] 」という書籍が出ていたので、購入してみました。Kindle版は「こちら(ドキュメント作成システム構築ガイド Kindle版)」になります。

次のように商品説明がされています。

エンジニアにとってドキュメント作成は避けて通れません。いまやドキュメント作成はコーディングと同様にエンジニアに必要な技術なのです。本書は、ソフトウェア開発の技法に基づいてドキュメント作成を支援するシステムを構築します。このシステムではGitを用いたバージョン管理、GitHubによる共同編集、RedPenによる品質チェック、CIツールによる継続的改善などを用います。


オープンにしてもよいドキュメント作成の環境をGitHub + Travis CIで構築して、そこでRedPenやAsciidoctorを利用することを想定して説明がされているようです。Markdown、Gitの使い方も必要なことが丁寧に説明されているのでわかりやすいと感じました。RedPenやAsciidoctorを使ったドキュメント作成がどこまで有効なのか、というのはやってみないとわかりませんが、何も使わずに個人のノウハウだけで作業をしているよりは、高品質なものができそうです。

オープンにできないGitリポジトリがある場合は、GitHubの有料サービスを利用する必要がでてきますが、GitLabなどを使えば自分で似たような環境を構築することはできるはずです。GitHubでも「GitHub · Where software is built」にある値段(個人だと$7、法人だと$25)で使えますから、どっちがいいのか、という感じでしょうか。Travis CIの「Travis CI – Test and Deploy with Confidence」をみると、こちらは個人で使うには厳しそうです。Travis CIと似たサービスとしては、Circle CIがあり、こちらの「Pricing and Plan Information – CircleCI」を見ると1コンテナなら無料だということなので、オープンにしないで個人で試しに組み合わせるならこちらの方が良さそうです。増やそうとすると次が4コンテナになるみたいで、そのときは$150/月です。ビルドはやはり結構な負担になりますね。

値段のことを考えると、エンジニアだとGitLab+Jenkins+Redmineといった環境を自宅で構築してしまいそうですね。もちろん、オープンソースの世界での活躍がステータスになる時代なので、ノウハウをオープンにして公開する方を選ぶ人もいるかと思います。

個人的にはドキュメントについてはGitでバージョン管理はしていますが、それほど本格的にドキュメント作成システムは用意していません。ただ、こういったシステムを導入して競争力を高めていく必要はあるのだろうと考えています。epub出版も個人でどんどんできる時代になってきていますからね…

同じタグの記事: Git
同じカテゴリの記事: Book
関連書籍: Git