UIを向上させるためには、操作ガイド画面を追加するのも一つの方法
アプリ:
GitHub:
初めに
各ユーザーによってどうしても操作が難しいといわれることがありましたので、操作を補助するような画面を作成したいと思い実行しました。
① 各ファイルをどのように扱ったのか
今回は、「作業時間」「ストレッチ」「グラフ・成果」の3つのカードの使い方を、1つの画面で切り替えて確認できる操作ガイドページを作成しました。
1. ルートとコントローラー
routes/web.php に /operation を追加しました。
ログインが必要なページのため、Setting画面と同様に、auth ミドルウェアのグループ内に配置しています。
Route::get('/operation', [OperationController::class, 'show'])
->name('operation');
OperationController は、ビューを返すだけのシンプルな構成にしています。
2. ヘッダーにタブを追加
partials/app-header.blade.php の「Home」と「Setting」の間に、「Operation」タブを追加しました。
<flux:tab
name="operation"
icon="book-open"
href="{{ route('operation') }}"
:current="request()->routeIs('operation')"
>
Operation
</flux:tab>
3. ページ本体と説明カード
operation.blade.php
Setting画面と同じレイアウト・背景画像を使用し、ページ内で説明カードを読み込む構成にしました。
partials/operation-guide.blade.php
説明カード本体を作成しました。
カード上部にある3つのボタンで、表示する説明を切り替えられるようにしています。
切り替えには、Livewireに含まれているAlpine.jsを使用しました。これにより、ページを再読み込みせずに表示を切り替えられます。
<div x-data="{ tab: 'work' }">
<button x-on:click="tab = 'work'">
作業時間カード
</button>
<!-- 各カードの説明 -->
<div x-show="tab === 'work'">
...
</div>
</div>
また、「時間をリセット」などの注意が必要な操作は赤い枠で囲み、ユーザーが注意点を認識しやすいように工夫しました。
4. 説明文をconfigにまとめた
最初は、説明文をBladeファイルの @php 内に記述していましたが、config/operationguide.php に移動しました。
return [
'items' => [
'work' => [
'label' => '作業時間カード',
'title' => '①作業カード',
'image' => 'img/guide/guide-work.png',
'items' => [
[
'name' => '「作業を始める」',
'text' => '...',
],
[
'name' => '「時間をリセット」',
'text' => '...',
'warning' => true,
],
],
],
// task、chartも同じ形式
],
];
Blade側では、config('operationguide.items') を読み込むだけの構成にしました。
これにより、説明文を修正したい場合は、基本的にconfigファイルだけを編集すればよくなりました。
② Canvaで画像を作成
1. 完成イメージの作成
最初に、操作ガイド画面の完成イメージとなる operating-guid.png をCanvaで作成しました。
- 使用したテンプレートや構成:(ご自身で記入)
2. 操作説明用の画像を作成
Home画面のスクリーンショットを撮影し、カードごとに①〜③の番号をCanvaで書き込みました。
- 番号の入れ方・色・フォントなど:(ご自身で記入)
3. 画像とコードの役割を整理
最初は、番号や枠をHTML・CSSのコードで追加していました。
しかし、画像そのものに番号や枠を入れたほうがシンプルになると考え、コード側に記述していた枠と番号を削除しました。
4. 画像の配置
書き出した画像は public/img/guide/ に配置しました。
| ファイル名 | 用途 |
|---|---|
guide-work.png |
作業時間カードの説明 |
guide-task.png |
ストレッチカードの説明 |
guide-chart.png |
グラフ・成果カードの説明 |
まとめ
機能が増えてくると、作った本人には当たり前の操作でも、初めて使う人には分かりにくくなることがあります。
操作ガイド画面は、そのような問題を手軽に補う方法の1つです。
今回の実装では、次の点を工夫しました。
- 既存の画面への影響を抑えた: 新しく作成したルート1つ、コントローラー1つ、ビュー2つ、configファイル1つを中心に実装し、既存の画面にはほとんど手を加えずに追加できました。
- 説明文の管理を簡単にした: 説明文をconfigファイルに分けたことで、文章の修正がしやすくなりました。
- コードをシンプルにした: Canvaで画像に番号や枠を入れることで、HTML・CSS側の記述を減らしました。
感想
今後は操作ガイドがいらないようなホーム画面を作っていけることがベストなのかな・・・と思っています。
