はじめに
これから自己学習のために、KotlinとVueを使用してトレーニング提案アプリを作成します。今まではToDoリストしか作っていなかったため、オリジナルの機能を作るのは初です…
アプリ作成については、設計書の作成から行うことにしました。
理由としては、実際の業務により近い開発手順で、アプリ作成を行い、仕事にも活かせるようにするためです。
アプリ作成の流れとしては、設計→実装→テスト作成という流れで行なっていきます。その度に記事も作成する予定です。
今回設計についての記事では、どのような設計書を作成したのかを記載していきます。
設計書の要素
今回、設計書はエクセルに以下のようにシートを分けて作成しました
・表紙
・機能概要
・画面遷移図
・ログイン画面
・新規ユーザー登録画面
・ホーム画面
・トレーニング提案入力画面
・トレーニング提案画面
・トレーニング変更画面
・トレーニング履歴画面
・ユーザー情報入力画面
・新規トレーニング追加画面
・DB定義
機能概要
機能概要では、トレーニング提案アプリの機能の概要、機能一覧、画面一覧を記載しました。
今回作るトレーニング提案アプリのメインの機能は、鍛えたい部位と消費したいカロリーを入力すると、そのカロリー分消費できるトレーニングメニューを提案してくれる機能です。
また、実施したトレーニングについては記録し、これまで実施したトレーニングの履歴等も見ることのできる機能も作成します。
画面遷移図
画面遷移図では、各画面がどのように遷移するのか記載しました。
基本的に、ホーム画面から各画面に遷移し、各画面での操作が完了したらホーム画面に戻る設計としています。
ログイン画面
ログイン画面は、トレーニング提案アプリで最初に表示される画面で、アプリを使用する際には「ユーザー名」「パスワード」を入力し、ログインする必要があります。
まだユーザーを登録していない場合は、新規ユーザー登録画面で登録することができます。
新規ユーザー登録画面
新規ユーザー登録画面では、「ユーザー名」「パスワード」を入力し、新しくユーザーを作成することができます。
作成が成功した場合、ログイン画面に遷移します。
すでに使用されているユーザー名は、使用できないようにする予定です。
ホーム画面
ホーム画面では、当日に実施する予定のトレーニングの表示と、各画面へ遷移するためのボタンを表示します。
トレーニング提案入力画面
トレーニング提案入力画面では、鍛えたい部位、消費したいカロリーを入力する画面です。
入力後にトレーニング提案ボタンを押下すると、トレーニング提案画面に遷移し、トレーニングを提案します。
トレーニング提案画面
鍛えたい部位、消費したいカロリーからトレーニングメニューを生成します。
トレーニングメニューについて一回あたりの消費カロリーを計算し、消費したいカロリーを超えるまでそれらを組み合わせトレーニングメニューを作成します。
作成が終わったらトレーニングメニューを表示し、承認ボタンを押した場合はトレーニング履歴テーブルに登録し、ホーム画面に戻ります。
トレーニング変更画面
トレーニング変更画面では、当日のトレーニング内容を手動で変更することができます。
トレーニング履歴画面
トレーニング履歴画面では、過去に行ったトレーニングの集計記録、日付ごとに行ったトレーニングの情報を表示することができます。
新規トレーニング追加画面
新規トレーニング追加画面では、新しいトレーニングを追加できます。
この画面については、トレーニング追加権限を持ったユーザーしか遷移できないように作成する予定です。
DB定義
今回DBは、ユーザーテーブル、トレーニングテーブル、トレーニング履歴テーブルの３つを作成しました。
ユーザーテーブル:ユーザーの情報を記録
トレーニングテーブル:トレーニングの情報を記録
トレーニング履歴テーブル:ユーザーごとに、行ったトレーニング、行う予定のトレーニングを記録
最後に
今回は、この設計書をもとに実装を行う予定です。
実装を行なっていく上で、設計で足りていない箇所もあると思うので、それらについてはメモ等しておき、次回以降の設計書作成でより良い設計書を作れるようにしていきます。