はじめに
私自身が、ベトナムに在住していて、オフショア会社に勤めております。
日本人コミュニティーのイベントに参加した際、ここなんか非効率だなと考えていた際、外付けの機能でなんか色々作れるのではと思いつき仕様書から書いてみました。
前提
・現在の実務は主に営業職です。なお、私が勤めている会社の手は、基本的に借りないものとする。
・勉強している言語はPythonとする。
・本来は、各ドキュメントを使うのですが、今回はこちらのサイトで記録します
・つまり自主制作です。もう一度言います自主制作です。
仕様書
1. 画面仕様
メイン画面
参加者情報の一覧が表示される。
各参加者の支払い記録、残金、通知が確認できる。
参加者情報入力画面
CSVやエクセルからのファイルアップロードボタンがあり、ファイルを選択することで参加者情報を一括で入力できる。
手動での参加者情報入力フォームが表示され、名前、連絡先などが入力できる。
2. 機能仕様
参加者情報の一覧表示
参加者情報が表形式で表示され、名前、支払い記録、残金、通知などが見やすく表示される。
支払いの記録
各参加者に対して支払い情報を手動で入力できる。
残金の計算
各参加者の支払い金額と実際の支払いすべき金額の差を計算し、残金を表示する。
通知機能
支払い期限が近づいた場合や、残金が残っている場合にユーザーに通知を送る。
データの保存
参加者情報、支払い記録、通知などのデータはデータベースやファイルに保存され、次回の利用に備えられる。
集計機能
飲み会の合計費用や各参加者の支払い状況を簡単に確認できる集計機能を提供する。
エクスポート機能
データをCSVや他の形式でエクスポートできる機能を実装し、必要な場合にデータを共有できるようにする。
3. データ構造
参加者情報
名前
連絡先
支払い記録（支払った金額、支払った日時など）
4. インフラ構成
フロントエンド: ユーザーインターフェースの表示
バックエンド: データ処理、通知、計算などのロジックの実行
データベース: 参加者情報、支払い記録などのデータの保存
5. その他
セキュリティ: ユーザーデータやイベントの情報を適切に保護するために、セキュリティ対策を実施する。
ドキュメンテーション: コードやアプリの使用方法に関するドキュメンテーションを充実させる。
詳細設計書
1. 参加者情報の一覧表示
1.1 概要
参加者情報を表形式で表示する画面の詳細設計。
1.2 画面レイアウト
ヘッダー: メニューへのリンクやアプリのタイトルを表示。
メインコンテンツ: 参加者情報の表を表示。
名前
支払い記録
残金
通知
1.3 機能
メイン画面に参加者情報を取得し表示する機能。
参加者情報の並び替えや絞り込み機能。
1.4 データ取得と表示
バックエンドから参加者情報を取得するAPIを呼び出し。
取得したデータを表形式に整形し、フロントエンドに表示。
1.5 ユーザーインタラクション
テーブルヘッダーをクリックすると、該当するカラムで昇順・降順にソート。
各参加者の名前や支払い記録をクリックすると、詳細情報がモーダルで表示。
1.6 エラーハンドリング
参加者情報の取得に失敗した場合、エラーメッセージを表示。
1.7 パフォーマンス
大量の参加者情報にも対応できるようにページネーションを実装。
1.8 テスト
単体テスト: バックエンドのAPIに対するテスト、フロントエンドのコンポーネントに対するテスト。
結合テスト: データの取得から表示までのフローに対するテスト。
最後に
いかがだったでしょうか。
今回は要件定義や詳細設計書を書いてみました。
実際に開発がすすんだら執筆いたしますので、お楽しみにしててください。