{success} チュートリアル機能の基本設計及び、画面設計を明記します。
チュートリアルは初回利用者に本システムを利用しやすくするための機能です。
各機能が完了（完了の定義は下部項目に明記）しているかどうかを常に表示し、
全て完了しても再度見直すことで、「what」をしたときに「where」で行うか分かるようにします。
また本システムにおける完了してもらいたい機能と、（その機能を完了しないと先に進めないような機能を指す。以降「必須機能」）
完了しなくても問題ない機能で、表示を変更します。（以降「任意機能」）
完了してもらいたい機能のみ、完了してもらいやすくするため常にアラートのように表示します。
完了しなくても問題ない機能は、表示は同列にされてますが、アラートのような扱い方は行いません。
※尚、順序は示しますが、ユーザーに応じて順序に限らず動作できるようにします。
そのため、利用ガイドと共に機能を知る為の機能となります。
{primary} COMPONENT に対する基本設計です
画面レイアウト 参考：JIRA
画面項目
| 物理名 | 項目・論理名 | タイプ | 桁数 | 必須 | 備考 |
|---|---|---|---|---|---|
| - | 機能名 | button | - | - | - |
| - | 完了％ | button | - | - | - |
| - | [drop]画面名 | text | - | - | - |
| - | [drop]表示内容 | text | - | - | - |
| - | [drop]完了％ | text | - | - | - |
| - | [drop]ガイドを表示 | button | - | - | - |
(例)
{機能名}監理団体 {完了%}50/100%(押下でdrop表示)
- [drop]{画面名}基本情報
- {表示内容}まずは確認してください
- {完了%}100%
- {ガイド}ガイドを表示
- 担当事業所
- 監理団体の事業所確認・必要なら追加
- 100%
- ガイドを表示
- 理事職員
- 追加してみよう
- 50%
- ガイドを表示
実習実施先 50/100%
- 新規登録
- 技能実習生が所属するまたは取引のある実習実施先を登録
- 100%
- ガイドを表示
...基本事項
| 項目 | 概要 |
|---|---|
| 実習実施先 | 実習実施先でログイン時は本機能非表示 |
| 完了機能 | 完了（100％）の機能も再度表示できる |
| 状態管理 | 状態は監理団体に紐づける。そのため各アカウントでログインしても共有される |
処理
| 開発 | 発火 | 処理名称 | 処理内容 |
|---|---|---|---|
| B | アクセス時 | 完了状態取得 | チュートリアル完了状態を取得する |
| B | アクセス時 | 完了％表示 | 取得した状態に応じて％を描画する |
| F | 機能名押下時 | [drop]表示 | 紐づく[drop]を表示する |
| F | ガイド押下時 | ガイド表示 | 押下したガイドが現在のページとは違うページならそのページへ遷移させる |
| 遷移先が編集画面の場合は、ガイドで編集画面へアクセスしてくださいと表示 | |||
| 同じページなら intro.js のようにガイドを表示する。 | |||
| ガイドの内容は実装者に任せます。実装後レビューします。 |
実装 API
| API 名称 | 処理内容 |
|---|
1.監理団体 必須機能
| 画面名 | 表示内容 | 完了タイミング |
|---|---|---|
| 基本情報 | まずは確認 | アクセス |
| 担当事業所 | 監理団体の事業所確認・必要なら追加 | アクセス |
| 理事職員 | 追加してみよう | アクセス 50％ / 登録時 100% |
| 書類保管 | 機能を知る・共有したい書類を保存できる | アクセス |
2.実習実施先 必須機能
| 画面名 | 表示内容 | 完了タイミング |
|---|---|---|
| 新規登録 | 技能実習生が所属するまたは取引のある実習実施先を登録 | 登録時 |
| 編集-実績 | 過去受け入れている場合または分かる場合、登録（各書類作成に必要） | アクセス 50％ / 登録時 100% |
| 編集-役員情報 | 分かる場合、登録（各書類作成時に必要） | アクセス 50％ / 登録時 100% |
| 編集-事業所所在地 | 事業所確認・必要なら追加（各書類作成時に必要） | アクセス 50％ / 登録時 100% |
| 編集-指導員情報 | 分かる場合、登録（各書類作成時に必要） | アクセス 50％ / 登録時 100% |
| 編集-雇用条件設定 | 過去受け入れている場合または分かる場合、登録（各書類作成・技能実習生登録時に必要） | アクセス 100％ |
| 編集-対応履歴 | 機能を知る・この実習実施先に対してのメモができる | アクセス |
| 編集-書類保管 | 機能を知る・共有したい書類を保存できる | アクセス |
3.送出国 必須機能
| 画面名 | 表示内容 | 完了タイミング |
|---|---|---|
| 新規登録 | 技能実習生が所属するまたは取引のある送出機関を登録（各書類作成・技能実習生登録時に必要 | 登録時 |
4.技能実習生 必須機能
| 画面名 | 表示内容 | 完了タイミング | 備考 |
|---|---|---|---|
| 新規登録 | 管理している or これから受け入れる候補の技能実習生を登録 | 登録時 | [実習実施先:新規登録][送出国:新規登録]が完了していないと登録できないと表示 |
| 編集-雇用労働 | 技能実習生の雇用条件を設定（各書類作成時に必要） | アクセス 50％ / 登録時 100% | [実習実施先:雇用条件設定]が完了していないと登録できないと表示 |
| 編集-入国後講習中の待遇 | 分かる場合、登録（各書類作成時に必要） | アクセス 50％ / 登録時 100% | |
| 編集-所属機関証明 | 分かる場合、登録（各書類作成時に必要） | アクセス 50％ / 登録時 100% | |
| 編集-試験の管理 | 分かる場合、登録/アラートが出る旨説明 | アクセス 50％ / 登録時 100% | |
| 編集-対応履歴 | 機能を知る・この実習生に対してのメモができる | アクセス | |
| 編集-書類保管 | 機能を知る・共有したい書類を保存できる | アクセス |
{info} ここまでで必要な設定は終了
-
計画認定書類 任意機能
| 画面名 | 表示内容 | 完了タイミング |
|---|---|---|
| 新規登録 | システム上で作成・管理・共有・保存・スケジュールできる | アクセス 50％ / 完了時 100% |
監理団体-報告書類 任意機能
| 画面名 | 表示内容 | 完了タイミング |
|---|---|---|
| 新規登録 | システム上で作成・管理・共有・保存できる | アクセス 50％ / 登録時 100% |
実習実施先-報告書類 任意機能
| 画面名 | 表示内容 | 完了タイミング |
|---|---|---|
| 新規登録 | システム上で作成・管理・共有・保存できる | アクセス 50％ / 登録時 100% |
監理費請求 任意機能
| 画面名 | 表示内容 | 完了タイミング |
|---|---|---|
| 新規登録 | システム上で作成・管理・共有・保存・送付できる | アクセス 50％ / 登録時 100% |
アカウント 任意機能
| 画面名 | 表示内容 | 完了タイミング |
|---|---|---|
| 新規登録 | アカウントを発行できます | アクセス 50％ / 登録時 100% |