ドキュメントツールにCrowiを導入しました

ドキュメントは非常に大事です。

公開しても良い情報や第三者に共有したほうが良い内容はQiitaに書き込むようにしていますが、公開できない内容、作業メモ、打ち合わせメモ、設計用技術資料、などを実際は公開できないほうが多いです。WordやExcelだと開くのに時間がかかるし、最新版管理、ドキュメントの内容を検索するといった事をするのも不便です。

そんなときに出会ったのがCrowiというドキュメントツールです。

Crowiはオープンソースのドキュメントツールで、サーバーにインストールして利用します。ソースコードがgithub上に公開されていて、無料で利用することができます。(ただし手動でインストールや設定をしていく必要があるのでサーバーの知識が必要です)。

CrowiではQiitaのようにマークダウンという記法でドキュメントを作成していきます。また、加えてUML(Unified Modeling Language)を使ってドキュメントに挿入する図を作成する事ができます。またElasticsearchを組み合わせることでドキュメントの検索も行う事ができます。

Crowiの導入によって仕事環境が劇的に変わりました。特に設計資料や作業手順の記録が爆速になったので、ドキュメント作成時間が短縮できただけではなく、記録する頻度も増えて非常に効率よく開発作業ができるようになりました。

おすすめの組み合わせは、これらの機能です。

左が書き込む領域で、右の領域に見た目をリアルタイムに表示してくれます。書きながらキレイなドキュメントが作成されていくので作業効率が良いです!!