blog 開発

【全然ダメ】要件定義のレビューが返ってきた!

こんにちは!要件定義のレビューが返ってきたので、共有していきたいと思います。

鈴木がはじめに作った要件定義

内容としては、こんな感じ

要件定義

【アプリケーション名】
タスク管理
【アプリケーションの概要】
パソコンで使える簡単なタスク管理アプリ
シンプルに登録したタスクが一覧表示されているTodo形式
タスク管理なので、期限もわかりやすくするためにガントチャートも表示する。

【どんな画面があって、どんな機能があるか】

<画面>サインアップ画面
ログイン画面
タスク表示画面
タスク詳細画面
タスク登録画面
ガントチャート画面


<機能>サインアップ:ユーザーの新規登録
ログイン:ユーザーの登録したアカウントでログイン
上記2つにバリデーションも追加
ログアウト
タスクの作成:新規タスクを作成
タスクの編集:内容の更新、タスクの削除、タスクの完了、タスクのアーカイブ
ガントチャート:タスクの期限がわかりやすいように表で表示する
タスクの優先度:タスクごとに優先度を分けてフィルタリングできるようにする

【アプリケーションは何で作るか】


Eclipse:4.30.0.20231201-1200
java:17
springboot:3.2.5 
データベース:H2

上記です!

ご指摘内容をパッとみて文章が多かったので、
おれ伸びしろありすぎ」と思ってしまったすずきですw
先生ありがとうございます!!

では、上から1個づつみていきましょう!!

【アプリケーションの概要】

【アプリケーションの概要】

パソコンで使える簡単なタスク管理アプリ
シンプルに登録したタスクが一覧表示されている
Todo形式タスク管理なので、期限もわかりやすくするためにガントチャートも表示する。

ご指摘1

パソコンで使える簡単なタスク管理アプリ

ご指摘1

→もう少し、ITな表現をしましょう。特に「パソコンで使える」とかは表現として幼稚です。  
例)シンプルな操作性のタスク管理ができるWebアプリケーションです。

すずき

いやーお恥ずかしいww
ビジネスライクの言葉遣いが下手すぎますねw

修正版

迷わないシンプルな操作性のタスク管理ができるWebアプリケーションです。

すずき

例にめっちゃ引っ張られてるのは内緒

ご指摘2

シンプルに登録したタスクが一覧表示されているTodo形式
タスク管理なので、期限もわかりやすくするためにガントチャートも表示する。

ご指摘2

→ここは文章になっていませんね。

アプリケーションの概要ですから、アプリケーションの概要をきちんと説明しましょう。
最初に伝えましたが、書く目的・ポイントは、読んだ人がこの文章だけでどんなアプリかを想像できることです。
あと、「シンプル」という言葉は概要としては重要な情報ではありません。

鈴木さんの文章では、登録するタスク内容がシンプルなのか、登録する操作方法がシンプルなのか、はたまた両方なのか伝わりません。どうしても言いたければ、飾りのような表現で最初か最後らへんの文章に混ぜるようにしましょう。

例)タスクを登録した後、登録したタスクを一覧表示で確認できます。
一覧表示の形式は、一般的なTodo形式と同様です。
一度登録したタスクは、内容の更新やタスク自体の削除もおこなえます。
また、完了したタスクには完了したことの表現もできます。
タスクは内容だけでなく期限の設定も可能です。
数のタスクの期限を可視化するために、ガントチャート形式の図で表示もおこなえます。これ以降、文章をより適切にビジネスライクな表現で改めてください。

すずき

Twitterの影響が出てしまっているw
語彙力とビジネスライクな表現ますと!

修正版

登録したタスクは、一般的なTodo形式でタスクが一覧表示で確認することができます。
登録したタスクでは、内容の更新や、タスクの削除、Todoが完了したら完了した表現をすることができます。
タスクは内容だけでなく、期限の設定をすることが可能です。
タスクの期限を可視化するために、ガントチャート形式の図で表示も行うことができます。

【どんな画面があって、どんな機能があるか】

【どんな画面があって、どんな機能があるか】

<画面>
サインアップ画面
ログイン画面
タスク表示画面
タスク詳細画面
タスク登録画面
ガントチャート画面

<機能>
サインアップ:ユーザーの新規登録
ログイン:ユーザーの登録したアカウントでログイン
上記2つにバリデーションも追加
ログアウト
タスクの作成:新規タスクを作成
タスクの編集:内容の更新、タスクの削除、タスクの完了、タスクのアーカイブ
ガントチャート:タスクの期限がわかりやすいように表で表示する
タスクの優先度:タスクごとに優先度を分けてフィルタリングできるようにする

ご指摘1

<画面>

  • サインアップ画面
  • ログイン画面
  • タスク表示画面
  • タスク詳細画面
  • タスク登録画面
  • ガントチャート画面
ご指摘1

→<機能>には、タスクの編集や削除について触れていますが、この機能をおこなうのはどの画面ですか?
 また、画面の名称だけでなく、どんなことをする画面なのか説明も付加しましょう。

すずき

指摘2とまとめて修正していきます!

ご指摘2

<機能>

  • サインアップ:ユーザーの新規登録
  • ログイン:ユーザーの登録したアカウントでログイン
  • 上記2つにバリデーションも追加
  • ログアウト
  • タスクの作成:新規タスクを作成
  • タスクの編集:内容の更新、タスクの削除、タスクの完了、タスクのアーカイブ
  • ガントチャート:タスクの期限がわかりやすいように表で表示する
  • タスクの優先度:タスクごとに優先度を分けてフィルタリングできるようにする
ご指摘2

→<画面>では、タスク登録という言葉になっていますね。できるだけ文言は合わせましょう。
 タスクの作成→タスク登録
 また、<画面>では言葉の後に全て画面と付けていますね。こちらも合わせて、全て機能を付けましょう。
 例)サインアップ機能(できれば、ここはユーザー登録機能)のほうがいいです。
   タスク登録機能...etc
 バリデーションについては、実装するのは当たり前中の当たり前なので、ここでの説明としては不要です。
 基本設計や詳細設計を書く時に記します。
 最後の「タスクの優先度」は、機能ですか?

すずき

修正版はこちら

修正版

サインアップ画面
・ユーザー登録機能(新規)

ログイン画面
・登録してあるユーザーでログインする機能

新規タスク作成画面
・タスク登録機能

タスク詳細画面
・タスクの編集機能(更新・削除)

ガントチャート画面
・ガントチャート機能

タスク一覧表示画面

【アプリケーションは何で作るか】

【アプリケーションは何で作るか】

Eclipse:4.30.0.20231201-1200
java:17
springboot:3.2.5 
データベース:H2

お褒めの言葉

→ちゃんとバージョン等も記しているのはグッドです:+1:

すずき

嬉嬉

修正版 要件定義

修正版要件定義

【アプリケーション名】
タスク管理

【アプリケーションの概要】
迷わないシンプルな操作性のタスク管理ができるWebアプリケーションです。
登録したタスクは、一般的なTodo形式でタスクが一覧表示で確認することができます。
登録したタスクでは、内容の更新や、タスクの削除、Todoが完了したら完了した表現をすることができます。
タスクは内容だけでなく、期限の設定をすることが可能です。
タスクの期限を可視化するために、ガントチャート形式の図で表示も行うことができます。

【どんな画面があって、どんな機能があるか】

サインアップ画面
・ユーザー登録機能(新規)

ログイン画面
・登録してあるユーザーでログインする機能

新規タスク作成画面
・タスク登録機能

タスク詳細画面
・タスクの編集機能(更新・削除)

ガントチャート画面
・ガントチャート機能

タスク一覧表示画面

【アプリケーションは何で作るか】

Eclipse:4.30.0.20231201-1200
java:17
springboot:3.2.5 
データベース:H2

こんな感じで再度レビュー投げてみます!!

重要

書く目的・ポイントは、読んだ人がこの文章だけでどんなアプリかを想像できること

  • この記事を書いた人

鈴木陽介

株式会社セブンコードの社畜 コンテンツマーケティング事業部の部長! ITパスポートの参考書もうすぐ発売

-blog, 開発