今日はよく用いられているドキュメンテーションツールに関して共有をしていきます。ドキュメンテーションツールはエンジニアやデータサイエンティストにとって必須のツールとなっています。

勿論知っている方は多いと思いますが、プログラミングを始めたての方やチームとしてのエンジニア経験が浅い方はどのようにプロジェクトを進めていくか意外と知らない事も多いためよく用いられているドキュメンテーションツールを紹介していきます。

チーム開発でよく用いられるドキュメンテーションツール (1) Confluence

世界中で使用されているツールであり、有名なタスク管理ツール「JIRA」やタスク管理ツール「trello」の開発会社でもあるAtlassianが2004年からリリースしているドキュメンテーションツールです。機能も非常に多く、JIRAやtrelloのようなタスク管理、アジャイルツールとの連携もスムーズで、直感的にわかりやすくチュートリアルも豊富なので初めてチームに導入するドキュメンテーションツールとしてはおすすめです。

社内Wikiのような形で使用が可能で、いくつかの機能を紹介すると、

なんといってもConfuluenceはもともと有料に加えて、個人レベルで使用することはできなかったのですが、最近ではなんと個人（10人まで）は無料で使用することができるようになりました。しかもページ作成は無制限とのことですし、バージョン管理機能ももちろん無料で使用することができます。少人数でのチーム開発でしたらまずConfuluenceを使用することはおすすめです。

ちなみに私は4年以上Confuluenceを使用しておりますが、たまにサーバーが遅いことを除けば、かなり機能も改善されてきて、業務用プロジェクトであれば基本的にはConfuluenceを使用しています。エンジニアであればJIRAと連携させて、リポジトリのブランチとプロジェクトページやタスクの紐づけなどを行うとかなり業務が効率化することができますので、おすすめです。

チーム開発でよく用いられるドキュメンテーションツール (2) Qiita Team

Qiita Teamはエンジニアの皆さんにとってはご存じQiitaの企業・チーム向けのサービスです。
エンジニアにとっては馴染みがあるUIに加えて、チーム内でのドキュメントの共有が非常に簡易的に行えるのが特徴です。

Qiita TeamsはQiitaおなじみのUIでエンジニアやデータサイエンティストの間でコミュニケーションがとりやすい、という大きなメリットがあります。もちろんMarkdown記法ですし、テンプレートがあり気軽に記事を投稿しやすいのが大きな特徴です。

7人までが使用できる少人数向けのSmallプランは月額4,900円、10人までのMediumプランは月額7,050円、17人までのLargeプランは月額15,300円といった費用となっています。また、17人以上のプランもExtraというプランで個別に対応しています。

チーム開発でよく用いられるドキュメンテーションツール (3) esa.io

esa.ioは2015年にリリースされた「情報を育てる」という視点で作られた自律的なチームのための情報共有サービスです。「とりあえず不完全でも公開」というコンセプトで作成されているため、WIP(Work In Progress: 進行中の作業)という機能があり、チーム内での情報共有がとても早く行う事が出来ます。

esaの重要なコンセプトとしてはやはりWIP機能で不完全の状態でもとりあえず公開することによって、業務を促進していくという精神ですね。Facebookでも有名なDone is better than perfectという有名な格言もありますが、完全主義で作成してしまう人も多い中、とにかく不完全でも早めに出して更新していくというサイクルを経ていく、というのは重要なコンセプトです。

esaでは基本的には記事のバックアップ機能や同時編集機能、リアルタイムプレビューといった他のドキュメンテーションツールでも使用できる機能は標準で入っており、費用は1人当たり月額500円という価格になっています。
また、最初の2か月間は無料で使用することができるので、WIP機能を重要視していきたい、早くプロダクト改善をしていく文化を根付けたい、という方にはひとまず登録して使ってみるのがおすすめです。

チーム開発でよく用いられるドキュメンテーションツール (4) Notion

Notionは「All-in-one workspace」というコンセプトをもとに作成されている共有ツールです。
勿論チームのドキュメンテーションツールとしても使う事が可能ですし、最近では少し変わった使い方として採用サイトの作成や簡易的なWebサイトをnotionで作成するケースが見られています。また、個人が使用するツールとしても使いやすいツールになっています。

私は普段個人用のプロジェクトはすべてNotionにいれており、Evernoteから乗り換えてもう4年近くNotionを愛用しています。自分の金銭的な管理から日記、趣味などはもちろん業務関連のPJをConfuluenceのように使用することができます。無料プランでもある程度使用することができますし、個人であれば月額$4(年間払いだと$5)の費用で使用することができます。

限定的ですが30日分であればバージョン管理もありますし、ファイルアップロード上限もありません。

チームプランであれば1ユーザーにつき月額$10(年間払いで$8)で使用することが出来ますので、個人用でもチーム用でもおすすめのツールです。また、前述したように一部のページだけきれいに編集して採用ページとして外部公開することも出来てしまう幅の広さを兼ね備えています。
その便利さからか、AnotionというNotionでWebサイトを作成するような外部サービスも出てきています。

ドキュメンテーションツールの比較

それでは今回紹介した4つのドキュメンテーションツールの比較をしていきます。

それぞれのメリット・デメリットを考慮した上で最も良いと思ったツールを使用してみましょう。大体のツールは無料使用期間があるので、ひとまずお試しで使用してみて合わなければ別のツールを使ってみる、という心構えでまずは色々試してみるとそれぞれの良さがわかってくると思います。

まとめ

今回はよく用いられるドキュメンテーションツールを4つ紹介してみました。どれを使うかで大きく変化があるわけではないですが、いずれにせよ進めているプロジェクトに関してのドキュメンテーションは必須スキルです。未来の自分や他人が理解できるようにまとめておくことで他のプロジェクトに知見を活かしたり、忘れていた手順を必死に思い出したりすることがないように普段からドキュメントをつける習慣化をしておくとより効率化した作業が出来る様になっていくと思います。

PA Labでは「AIを用いた自動化×サービス開発」の専門家として活動をしています。高度なデータ分析からシステム開発まで一貫したサービス提供を行っており、特に機械学習やディープラーニングを中心としたビジネス促進を得意としております。

無料で分析設計/データ活用に関するご相談も実施中なので、ご相談があればお問い合わせまで。