はじめに
設計書をExcelやWordを用いて管理していると不便だと思うことが多々あります。
- 探したい情報がどこに記述されているかわからない。全体から検索ができない。
- 誰がどこを変更したのかわからない。変更履歴が管理しづらい。
- ファイルサイズが大きいと処理が重い。強制終了して編集内容が消えることも。
こういった点を解消するため、設計書をMarkdownで管理したいと思い立ちました。
そして、利用できそうなツールを調査してみたところ「GROWI」が見つかりました。
「GROWI」とは？
MITライセンスで公開されているオープンソースソフトウェアです。
有料でクラウド版も提供されていますが、オンプレ環境が用意できれば無料で利用することができます。
他にも様々なツールがありましたが、以下の点からこのツールを選定しました。
- 無料で利用できる
- 日本語対応している
- 全文検索や更新履歴が利用可能
インストール
まずは個人での試用であるため、Dockerを用いてインストールしました。
以下のコマンドを実行するだけでセットアップ完了となり、非常に簡単でした。
git clone https://github.com/weseek/growi-docker-compose.git growi
cd growi
docker-compose up
詳しい内容は以下のサイトに記載されています。
試用してみて良かったと思った点
Markdownの編集がしやすい
左画面で編集しながら右画面にプレビューが表示されるので体裁が整っているかリアルタイムで確認ができます。
またエディタにテーブルやリンク等の入力ボタンが用意されているため、Markdownに慣れていない人にとっても扱いやすいと感じました。
さらにテンプレートを保存して利用できるため、設計書で様式を統一しなければならない際に利用できそうです。
diagrams.net（Draw.io） や PlantUML が利用可能
シーケンス図やクラス図の作成に用いられる作図ツールが利用できます。
AWSの構成図などの作成にも役立ちそうです。
全文検索が可能
高速検索を可能とする検索エンジン（Elasticsearch）を利用した検索が可能であるため、探したい情報をすぐに見つけることができます。
ExcelやWordで設計書を管理する際に感じていた不便な点が解消されそうです。
課題
Markdown形式での全体エクスポートができない
確認した限りでは個別のファイルはMarkdown形式でエクスポート可能ですが、一括で全体のエクスポートはできないようです。
会社のルール上、社内のファイルサーバにMarkdownのファイルを残しておく必要あるので、別途方法を検討しなければなりません。
おわりに
課題は残りましたが、「GROWI」は設計書をMarkdownで管理するための有用なツールであると思いました。
個人の範囲でした試用できていないので、ぜひ次回のプロジェクトで活用していきたいです。