項目
4. 開発標準・サイトツアー規約¶
ここでは、 intra-mart Accel Platform でのサイトツアーについての開発標準を記載します。
4.1. サイトツアーのメッセージを記載する観点¶
intra-mart Accel Platform では、以下の観点を基にサイトツアーを実装しています。
- ボタンやアイコン画像等にあるイベントの説明
- 複雑な操作画面に対する操作説明
- 特定の条件下のみ利用できる機能の説明
- 画面上からはわからないキーボード操作
コラム
intra-mart Accel Platform のすべての画面にサイトツアーが実装されているわけではありません。
必要に応じて徐々にサイトツアーを実装していく予定です。
4.2. サイトツアーの種類¶
intra-mart Accel Platform ではサイトツアーを以下のように分類しています。
4.2.1. 各要素に補足説明をする¶
- ボタンやアイコン画像など、直感的に操作しづらい要素に説明を追加したい場合です。
- 一括表示を使います。
- ボタンのラベルだけでは、どうなるのかが判断できない場合などに補足説明を記載します。
- アイコン画像にクリックイベントが仕込まれている場合など、機能説明を記載します。
4.2.2. 手順を示す¶
- 初めて画面を操作するユーザを対象にした手順を示したい場合です。
ステップ表示を使います。
初めて操作するような画面において、どのような操作をすればよいかを促すものです。
- 最低限の情報以外となるような画面項目の説明などは、仕様書などの別ドキュメントに記載します。
- この手順がないと先に進めないというような最低限の情報をサイトツアーとして表示します。
4.2.3. 機能ごとに説明する¶
- 画面内に説明したい要素が多く、ある程度のグループ毎に説明したい場合です。
- ステップ表示を使います。
- ヘッダー部分だけを一括で説明したあとに、左ペインだけを一括で説明したい場合などにグループに分けて説明を記載します。
4.3. サイトツアーのメッセージに対する注意点¶
サイトツアーのメッセージを実装する際の注意点は以下になります。
4.3.1. 指針¶
ドキュメントで補っている内容や、ユーザビリティが高く説明が不必要な画面には説明を記載しないでください。
- 細かい仕様についての記載など、説明量が多くなる内容は記載しないでください。
- 画面内にたくさん情報があると、逆に分かりづらさが際立ってしまうためです。
4.3.2. 書き方¶
受動態を使わず、能動態で記載します。
- 可能な限り短文で記載します。
- 英語や中国語などを考慮し、長文にならないようにしてください。
敬体で記載します。
4.3.3. メッセージの保管場所¶
- 通常画面の実装と同様に、 メッセージプロパティ として設定します。
- 多言語分を必ず設定するようにしてください。