はじめに・読み方

このサイトは、チームの作業を共有するタスク管理システムを題材にした仕様書サンプルです。 作業内容・担当者・期限を登録し、進捗を一覧で確認する Web アプリを説明します。

このサイトで確認できること

MkDocs + Material for MkDocs を使った、ページ構成・図・表の書き方を示しています。 タスク管理アプリの操作デモではありません。画面の URL や API は仕様上の例です。

初めて読むときの順番

flowchart TD
    A[目的と対象範囲<br/>何を解決するシステムか] --> B[用語とステータス<br/>言葉の意味をそろえる]
    B --> C[機能一覧<br/>何ができるか]
    C --> D[画面仕様<br/>どう操作するか]
    D --> E[API仕様<br/>どんなデータをやり取りするか]

順番	ページ	読むと分かること
1	目的と対象範囲	利用者、解決したい課題、含める機能・含めない機能
2	用語とステータス	タスク・担当者・期限・進捗状態の意味
3	機能一覧と確認観点	機能ごとの役割、実装・テスト前に確認する点
4	画面遷移と入力項目	一覧・登録・編集のつながり、入力ルール
5	API仕様	一覧取得・登録のリクエストとレスポンス

タスク1件の操作例

チームで「仕様書レビュー」を依頼する例で、登録から進捗の更新までを確認します。

操作	具体例	参照する仕様
作業を登録する	タイトル「仕様書レビュー」、担当者、期限、優先度を入力	タスク登録
作業を探す	一覧で担当者を絞り込み、タイトルで検索	タスク一覧
進捗を共有する	編集画面でステータスを「進行中」「完了」に変更	タスク編集

読者別の参照先

読む人	先に確認するページ	確認したいこと
要件を確認する人	目的と対象範囲 → 機能一覧	必要な機能が含まれているか
実装する人	画面仕様 → API仕様	入力項目・データ形式・画面の動き
テストする人	機能一覧と確認観点 → 画面仕様	正常操作、入力制限、削除確認
MkDocsで仕様書を作る人	作成・公開の解説記事 → ソースコード	ページ構成、設定、Markdownでの図・表の書き方

未定義の仕様について

このサンプルは、実装に必要な全仕様を網羅していません。 更新・削除API、画面の認証・権限、状態変更の制約などは未定義です。 各ページの「要確認」を、実際のプロジェクトで埋める論点として使ってください。

次は 目的と対象範囲 で、システムの全体像を確認します。