👏

エンジニアが実装に入る前に読む仕様書の確認ポイントをまとめてみた

2021/11/15に公開

会社で使っているチェックリスト的なものを共有します。PdMさんに読んでもらったり、仕様レビュー会で使っていただけると嬉しいです。他にも追加するべき項目があれば、コメントで教えてください。

全体

  • ブラウザタブのタイトルはどうするか?
  • 権限の有無やデータ取得の可否などで条件分岐する場合のパターンの挙動は網羅しているか?(表ベースで記載されていると分かりやすい)
  • 日付を表示させる時のフォーマットはどのようなものか?
    • YYYY/MM/DD HH:mm?
  • ボタンがある場合は、そのボタンのenable/disableの条件は何か?
  • ボタンがある場合は、それをクリックすると何が起きるか(ユーザー権限がある場合は、権限ごとの挙動はどのようなものか?)

一覧系

  • データ取得に時間がかかっている場合は何を表示するか
  • データが取得できなかった場合は何を表示するか
  • データ取得時にエラーが発生した場合は、どのようなフィードバックをするか
  • データの表示順序ルールは決まっているか
  • データの表示件数ルールは決まっているか
  • データの表示文字数に制限はあるか
  • 特定の列でソート機能は必要か?
  • 複数のソートキーを使ったソートは必要か?
  • ページャーで2ページ目以降に移動した際に、ソートを実行するとどうなるか?

詳細系

  • データが取得できなかった場合は何を表示するか?
  • データ取得時にエラーが発生した場合は、どのようなフィードバックをするか
  • データの表示文字数に制限はあるか

フォーム入力系

  • 入力画面
    • 文字数(下限・上限)
    • 入力できない文字列
    • 次へボタンの活性状況はバリデーションを満たすまでdisable? or 常にenableだが、バリデーションをクリアしていないとエラーが出る?
    • どういう形式の入力フォームか?(フリー、textarea、プルダウン、ラジオボタン、チェックボックス、マルチセレクトなどなど)
    • ファイルアップロード時に受け入れる拡張子は何か?
    • ファイルアップロード時のファイルの容量上限はどれくらいか?
  • 確認画面
    • 確認画面は必要か
    • フリーで入力したリンクは有効化されるか
    • HTMLは有効になるか
  • 完了画面
    • Submitが成功した時は、どのようなフィードバックをするか
    • Submit時にエラーになった場合は、どのようなフィードバックをするか

Discussion