#目的#
個人開発のアプリの設計書を作成・管理するツールを比較し、よさそうなものを選ぶ。
また、下記の点について留意する。
・Excelなどのソフトウェアへの依存度が高いものではなく、マークダウンで記述できるもの
・使用・導入のコストが低そうなもの(実際に支払うお金や参考になる情報があるかなど)
#比較したもの#
調べたところ、下記の3つが検討対象になりました。
- GitBook
- Growi
- Confluence
#結論#
個人開発だったらGitbookかGrowiのどちらかで十分だと思う。
出来ることはどちらもほぼ同じだおもうので、
あとは画像貼り付けが楽とかの使用感とか、
環境(nodejsだけかnodejs+mongodbか)などでどちらを使うが決まりそう。
Confluenceはもっと大人数のチーム向けの管理ツールのように思われた。
いかに調べた限りの長所・短所(Pros, Cons)[メリット・デメリット]を書いていきます。
#Gitbook#
https://www.gitbook.com/
Gitで管理ができるBookみたいな意味のアプリ名だと思います。(開発元的な意味合いではGithubは関係ないようです。)
よさそうな点
・無料
・マークダウンで記述ができる
・目次がつけられる(階層化が簡単そう)
・.md->.htmlへ変換をするので、それをGithubのリポジトリへあげてGithub Pagesで公開ができる
・UML、チャートなどの記述がプラグインによってできる。
・デフォルトで記事の全文検索ができる。
微妙そうな点
・pdfの出力ができない
・CLIがあるけど、メンテが止まってる(らしい)
動作環境に必要なもの
・nodejs
以下の記事を参考にしています。
#Growi#
よさそうな点
・無料
・マークダウンで記述ができる
・目次がつけられる(階層化が簡単そう)
・差分がとれる
・動作が早い(らしい)
・UMLの記述がプラグインによってできる。
・デフォルトで記事の全文検索ができる。
・表が書きやすい
・画像がはりやすい
・環境構築が簡単
微妙そうな点
・印刷がむずかしい
・CLIがあるけど、メンテが止まってる(らしい)
動作環境に必要なもの
・nodejs
・mongodb
#Confluence#
よさそうな点
・無料(10ユーザーまで)
・テンプレートが多そう
微妙そうな点
・情報がすくない。
#おわりに#
結論に書いた通り、GitbookかGrowiを使ってみます。
どちらも導入がかなり簡単だと思うので、いくらかつかってみて決めようかな。
下記記事をみると、その後のメンテで自分以外の人を使う必要が出てきたときとかにGitbookのほうがよいのかな?と思うけど、
Markdownで記述してあるからGrowiを使ってもきっとなんとかなるのかなと思ってみたり。
https://qiita.com/KeitaMoromizato/items/04ac6058010248b3ce82