【Notion】システム開発における設計書の管理方法
2023/06/28
弊社では最近、新たなドキュメント管理ツールとしてNotionを導入しました。Notionは非常に使いやすく、システムの仕様書管理とも相性が良かったので、今回はその魅力をご紹介したいと思います。
Contents
Notionに移行した経緯
以前は、Confluenceを使ってドキュメントの管理を行い、Jiraでタスク管理を行っていました。しかしNotionを試してみると、これらの機能を兼ね備えているだけでなく、カスタマイズ性が高く、操作性も良いのでドキュメント作成に適していると感じました。ツールを一元管理することで総合的なコストも下がるので、Notionへの移行に踏み切りました。
それでは、各仕様書の具体的な記載内容についてご紹介します。 今回は下記仕様書に絞って記載しています（他にも業務フロー図や状態遷移図、エラーメッセージ一覧などシステム仕様で必要なドキュメントは全てNotionで作成しています）
- 画面仕様書
- 画面遷移図
- ER図
記事の最後には画面仕様書テンプレートの公開リンクも記載しています。興味がある方はそちらも参照いただけますと幸いです。
画面仕様書
各画面の仕様書に記載している内容をご紹介します。 画面仕様書全体のイメージはこちらを参照いただけますと幸いです。
ユーザーストーリー
画面ごとに、エンドユーザーの視点で想定する業務内容を定義しています。
画面遷移
該当画面への遷移、該当画面から別画面への遷移について定義しています。
デザイン
Notion – Figmaを連携しておくと、Figmaで作成したデザインのURLを貼り付け、プレビュー表示させることが可能です。 新規登録時、編集時、削除時など、状態によって表示内容が変わる場合はデザインパターンを複数作成しています。
項目定義
表示エリア別に項目ごとの仕様を記載しています。 エリアによって異なる項目定義のテンプレートを使用しており、各エリアの目的や機能が明確になるようにしています。
コンポーネント欄では、リストから選択する形式で入力や表示のフォームを選択できるようになっています。 Notionの「テーブルビュー」でコンポーネントリストを作成し、プロパティの設定でそのリストから選択することが可能です。 「テーブルビュー上でプロパティの編集」→「種類＝リレーションを選択」→「リレーション＝作成したコンポーネントリストを選択」
画面遷移図
画面ごとのアクションと遷移についてMermaid記法で記述しています。 変更時にもNotion上ですぐ編集できるので、メンテナンスしやすいです。
下記がMermaidコード記載例です。 プレビュー上で画面ごとにリンクを設定することも可能です(click {画面名} "{URL}" )
ER図
画面遷移図と同様にMermaid記法で記述しています。 テーブル定義はjson構造のような記載をしているので項目の変更がしやすく、データベース生成ファイルへの反映もしやすくなっています。テーブル間のリレーションも記載可能です。
Notionで管理して良かったこと
Notionで管理することによる効果は次の通りです。
- 汎用的なテンプレートの作成が容易であり、効率的にドキュメント作成が進められます。
- 画面遷移図やER図などの図解もNotion上で簡単に記述できるため、ドキュメントのメンテナンス性が向上します。
- テーブルビューで作成したリストから選択することで、仕様書上の表記揺れも無くなります。
- Figmaのデザインパターンと仕様書内の設計パターンを対応させて記載することで、記載ミスや考慮漏れを減らすことができます。
- Notionでは常に編集モードで作業するため、ちょっとした仕様修正なども素早く記述することができます（Confluenceでは参照モードと編集モードが分かれていたので若干更新が面倒でした…）。
画面仕様書テンプレートのご紹介
最後に改めて、今回ご紹介した画面仕様書のテンプレートについてご案内します。こちらからご確認いただけます。
※今後も随時バージョンアップしていきます。
Notionの使いやすさと機能の豊富さにより、弊社では効果的にプロジェクト運用が進められています。皆さんもぜひNotionを試してみてください。 また、今回は仕様書の概要レベルの解説に留めてますが、需要がありそうでしたら別の記事でより詳細な記載方法のご紹介ができればと思います。Notionでのタスク管理の記事もどこかでアップする予定です。
以上が、Notionによる仕様書の管理方法についてのブログ記事でした。お役に立てれば幸いです。