- TBWユーザーガイド
- 概要
- ガイドライン
- チュートリアルの作成
1. セクション、手順、注釈の数
チュートリアルを作成する際に使用できるセクションと手順の最大数は以下の通りです。ただし、調査の結果、少ないほど良いことがわかっています。ただし、調査の結果、少ないほど良いことがわかっています。
推奨事項
- セクション:ひとつのチュートリアルに含めるセクションの数は、できれば4つ未満にします。セクション数の上限は10個です。
- 手順:ひとつのセクションに含める手順は最大5つですが、できれば3つまでにします。ひとつのセクションを多数の手順で構成することは避けてください。
- 注釈:ひとつの手順に含める注釈の数は2つを上限とします。
ヒント:セクション、手順、注釈の書き方については、チュートリアルの作成/チュートリアルを参照してください。
文字数
TBWの各テキストフィールドには、文字数の制限を守りやすいようにカウンターが備わっています。
テキストフィールド |
最大文字数 |
推奨文字数 (スペース含む)(全角1字は2文字として計算) |
チュートリアルのタイトル |
120 | 100 |
チュートリアルの説明 |
150 |
125 |
スターターテンプレート | 120 | 100 |
セクションのタイトル |
120 |
100 |
セクションの説明 |
150 |
125 |
手順 |
200 |
170 |
注釈 |
200 |
170 |
完了メッセージ |
200 |
170 |
2. タイトルと説明
チュートリアルのタイトル
- チュートリアルの内容が伝わるようにタイトルを設定します。
- SEOフレンドリーかつ検索可能なタイトルにしてください。
- タイトルの末尾には原則として体言止めを使用し、「~する」のような表現は避けます。
- 例: :調整レイヤーを使用して暗い写真を明るく
- タイトルに「~する方法」や「~する方法を学ぶ」という表現の使用は避けます。
- タイトルに製品の機能名称を含める場合は、機能の使いみちも示すようにします。
- 例: 修復ブラシツールを使用して写真からオブジェクトを除去
- 空白も含めて120文字を上限とします。できるだけ短いほうが良いタイトルです。
- タイトルは短くします。
セクションのタイトル
- セクションのタイトルは体言止めにし、そのセクション内の手順を実行することで得られる結果を簡潔に記します。
- 例:アートワークの外観を調整
- 体言止めにするのは、セクションのタイトルを手順と勘違いするユーザーがいるためです。体言止めで簡潔に記述することで、混乱を避けることができます。
- セクションのタイトルの末尾に句点(。)は付けません。
チュートリアルの説明
- チュートリアルの説明は、チュートリアルのスタート画面でタイトルの下に表示されます。そのチュートリアルの概要とメリットを説明するために使用します。
- チュートリアルの説明の末尾には句点(。)を付けます。
- 例:明るさとコントラストを調整して暗い写真の見栄えを改善します。
セクションの説明
- セクションの説明は、セクションのタイトルの下に表示されます。そのセクションで学習する内容を伝えるために使用します。できるだけ短くするよう心がけてください。
- セクションの説明の末尾には句点(。)を付けます。
- 例:レイヤーマスクを使用すると、その下にある画像レイヤーの状態を維持したまま、画像レイヤーの一部を非表示にすることができます。
3. UIエレメント
手順を作成するときは、必要に応じて、ユーザーがタスクを完了するのに役立つ特定のツール、メニュー、またはパネルを指定します。手順のテキストフィールドで「@」記号を使用して検索し、関連するツールや機能を見つけて挿入します。
「@」記号を入力すると、選択可能なツールまたは機能の候補リストが表示されます。選択すると、UI名はテキストの残りの部分とは異なる書式で表示されます。コーチマーク(青いボックス)が作成され、正しいツールや機能をユーザーが視覚的に理解しやすくなります。
目的のツールや機能がメニューにない場合は、その名前を「@」記号なしで入力します。パネルおよびメニューコマンドには、ワークフローを示すために「/」を使用します。製品自体のUIエレメント名のみを使用します。 この場合、コーチマークは作成されません。
- 例:レイヤー/レイヤーアクション/レイヤーをロック
「@」記号を使用しても利用できないツールや機能がある場合は、Learn Global Operationsチームの担当者にお知らせください。
4. 用語
コンテンツ作成者は、以下の表に記載されている用語を使用してください。
頭字語
頭字語 |
名称 |
定義 |
CCD |
Creative Cloudデスクトップアプリ |
各種アプリの管理ツール。新しいビルドはここで入手してインストールできます。 |
DP |
もっと知るパネル |
チュートリアルを表示する製品パネルです。 |
LCM |
学習コンテンツ/ラーニングコンテンツ |
「もっと知る」パネル内に学習チュートリアルを表示する領域を指すエンジニアリング用語です。 |
LCP LCP |
学習コンテンツポータル 学習コンテンツポータル |
ユーザーがUtuts、プレイリスト、コレクションを管理するためのポータルです。 |
Ps |
Photoshop | 画像補正から加工、webデザインまで対応できるプロフェッショナル画像編集ツールです。 |
PsW | Photoshop web版 | Webブラウザーで利用できる多機能なデジタル画像編集およびデザインアプリケーションです。 |
TBW | チュートリアルビルダーweb | ガイド付き実践チュートリアルの構築ツール。Web上でアドビ製品を操作しながら使い方を学ぶ環境をユーザーに提供できます。 |
製品の名称
チュートリアルに製品名を記載するときは、以下のガイドラインに従います。
- 「良い例」列に明記されていない限り、製品名に「Adobe」を含めないでください。
- 製品名「Photoshop」は、明確にすることが重要な場合以外は明示しません。製品名「Photoshop」は、明確にすることが重要な場合以外は明示しません。
- 製品名には「CC」を含めません。
- 製品名を記載する必要がある場合は、次の表の「良い例」列にある表記を使用します。
良い例: |
悪い例: |
Adobe Dimension |
Adobe Dimensions |
Adobe Fonts |
Fonts |
Adobe Stock |
Adobe Stock個人版 |
Camera Raw |
Adobe Camera Raw ACR Photoshop Camera Raw |
Fresco |
Adobe Fresco |
Illustrator |
Adobe Illustrator |
Illustrator iPad版 |
iPad用Illustrator |
ライブラリ |
CCライブラリ |
Lightroom Classic |
Lightroom Classic CC |
Lightroom(クラウドベース) |
Adobe Lightroom Photoshop Lightroom Lightroom CC |
Lightroomモバイル版 |
モバイル用Lightroom |
Photoshop |
Adobe Photoshop |
Photoshop iPad版 |
iPad用Photoshop |
チュートリアルに特有の用語
ふさわしい用語について検討したうえで、使用すべき表現と避けるべき表現を次の表にまとめています。理由とともに確認してください。用語の整合を図ると、ユーザーにとってわかりやすい学習環境が育まれます。
良い例 | 悪い例 | 理由 |
ファイル/保存を選択します 「スマートオブジェクトに変換」を選択します |
ファイル/保存をクリックします 「スマートオブジェクトに変換」を選びます |
メニュー項目をアクティブ化する必要があることを示すのにふさわしい用語。 |
切り抜きツールを選択します レイヤーを選択します |
切り抜きツールを選びます レイヤーをクリックします |
ツール、レイヤー、またはサムネールをアクティブ化する必要があることを示すのにふさわしい用語。 |
不透明度スライダーをドラッグします 花をドラッグします ドラッグして長方形の範囲を選択します |
不透明度スライダーをクリックしてドラッグします 花をクリックし、ドラッグします |
UI項目または画像の一部をドラッグする必要があることを示すのにふさわしい用語。 |
|
テキストフィールドのスペースと文字数を節約するために修飾キーの略称を使用。 テキストフィールドのスペースと文字数を節約するために修飾キーの略称を使用。 修飾キー名の後にプラス記号(+)を付けます。
プラットフォームによって異なるコマンドには(Win)または(macOS)を付記します。 |
|
境界の外側にカーソルを移動します |
境界の外側にポインターを移動します |
マウスの操作を示す。 |
ツールバー |
ツールパネル、ツールパレット |
ツールバーの操作を示す。 |
描画モードメニュー(通常)をクリックし、「スクリーン」描画モード |
ブレンディングモード、ブレンドモード |
テキストフィールドボックスに「@」を入力すればツールまたは機能が表示されることになっていますが、この方法では一部のツールや機能が表示されない場合があります。 この方法では一部のツールや機能が表示されない場合があります。 ツール名やメニュー項目名が英字の場合、先頭を大文字にします。ツールや機能の名前がわからない場合は、UIエレメントの上にポインターを合わせると正しいスペルが表示されます。 |
|
簡単、単純 | 「簡単」や「単純」という表現は、初めてのトピックを学ぶユーザーの感情にそぐわないおそれがあります。 「簡単」や「単純」という表現は、初めてのトピックを学ぶユーザーの感情にそぐわないおそれがあります。 学習者の身になって考え、学習内容を説明するために必要な場合以外「簡単」や「単純」という表現を避けてください(例えば、実際に他の方法より手早くできることを客観的に述べる必然性がある場合は使用できます)。 学習者の身になって考え、学習内容を説明するために必要な場合以外「簡単」や「単純」という表現を避けてください(例えば、実際に他の方法より手早くできることを客観的に述べる必然性がある場合は使用できます)。 代わりに、「短い」、「複雑でない」、「時間のかからない」などの表現を使用してください。 |
|
学習、コース、クラス、トレーニング、レッスン、指導、指示、教育、宿題、演習 |
調査によると、チュートリアルコンテンツは「初心者にしか関係ない」、「非常に頭い、労力を費やす必要がある」とユーザーに思われがちです。
学習アクティビティについて述べるときは、取っつきやすくて堅苦しさがない言い回しを心がけてください。 |
Illustrator Express Photoshop Photoshop web版 |
個々のチュートリアルコンテンツの内容はあらかじめひとつの製品に特化しています。「Express」や「Photoshop」というわかりきった対象製品名をチュートリアル内で述べることは基本的に避けるべきです。 個々のチュートリアルコンテンツの内容はあらかじめひとつの製品に特化しています。「Express」や「Photoshop」というわかりきった対象製品名をチュートリアル内で述べることは基本的に避けるべきです。 ただし、例えば説明のためにExpressとPhotoshop web版の機能を対比させる場合など、必要があるときには使用してください。 |
5. 句読点と記号
説明、手順、注釈の文末にピリオドを付けるなど、正しい句読点を使用してください。タイトルに句読点や記号は付けません。
チュートリアルの要素 |
句点の必要性 |
チュートリアルのタイトル |
なし |
チュートリアルの説明 |
あり |
セクションのタイトル |
なし |
セクションの説明 |
あり |
手順 |
あり |
注釈 |
あり |
6. 用字とキャピタリゼーション
ガイドライン |
適切な使い方 |
英字の場合、UIエレメント名の先頭は大文字にするがエレメントのタイプは先頭を大文字にしない |
|
英字の場合、複数の単語から成るUIエレメント名は最初の単語の先頭のみ大文字にする |
|