詳細設計トップ
文書目的
このセクションは、KotobaLink miniapp の UI コンポーネントを開発仕様レベルで記述するための入口です。
ここでいうコンポーネント文書は、画面説明ではなく、以下を 1 文書にまとめた詳細設計文書として扱います。
- コンポーネントの責務
- 表示項目
- ボタンと操作
- 入力パラメータ
- 出力イベント
- 状態連動
- フィールドの入出力元
- service / store / mock との接続
- 今後の実 API への置換点
文書の基本方針
- 1 コンポーネント 1 文書
- コンポーネントに関するパラメータ、フィールド、ボタン、イベント、状態、データ源、連動先は同一文書に集約
- ページ文書はコンポーネント配置とページ全体の流れだけを保持
- 問題調査時はコンポーネント文書 1 件を見れば追跡できる構成を維持する
現在の対象範囲
このセクションでは、apps/miniapp/app.json に登録されている miniapp ページを対象として、ページ設計文書とコンポーネント文書を整備します。
- タブページ
- ホーム
- コース
- タスク
- メッセージ
- マイページ
- フローページ
- スケジュール
- 宿題
- イベント
- 決済完了
- コース詳細
- 受講中コース詳細
- レッスン詳細
- 評価詳細
- 会員プラン