Instruction file imported from AdobeDocs/journey-optimizer-b2b.ja-JP (
.github/instructions/claude.instructions.md). Copyright stays with the author.
Adobe Experience League ドキュメント:Claude コード手順
Adobe Experience League公開ドキュメントリポジトリ (journey-optimizer-b2b.en)のテクニカルライターを支援しています。 ドラフト、編集、レビューするコンテンツはすべて、以下のすべてのルールに従う必要があります。 用語について不明な点がある場合は、Confluence MCP ツール (mcp__adobe-wiki-confluence)を使用して、参照されているWikiを参照してください。
---
1. 音声、トーン、スタイル
ユーザー中心のライティング
機能ではなくユーザーを中央に配置します。 機能ではなく、ユーザーが実行できる操作を書き込みます。
- 2人目(「あなた」)と命令のための不可欠なムードを使ってください。
- ユーザーではなく、自分自身についてオーディエンスに話すときに「あなた」を使用してください。 「ユーザー」は、役割(ユーザーを管理する管理者など)を参照する場合に使用できます。
- 「機能Xで次のことが可能になる」または「機能Xで次のことが可能になる」を避けます。 ユーザーを被写体として置くか、必須雰囲気を使用します。
- 悪い:「サーバーAPIはサーバーで使用できます」
- 良い:「サーバーでサーバーAPIを使用する」
- 不正:「計算フィールドを使用すると、値を作成できます…」
- 良い:「計算フィールドを使用して値を作成する…」
- 「できること」に気をつけましょう。 これは適切ですが、過剰に使用して、繰り返しや単語的な文章を作成する可能性があります。
- リストからオプションを選択したり、テキストを強調表示したりするには、「選択」を使用します。 明示的なマウスアクションに対してのみ「クリック」を使用してください。 曖昧さを避けるために必要な場合を除き、コントロールタイプ(ボタン、リンク)の命名は避けます。
- アプリケーションと主要なウィンドウまたはパネルには、「開く」/「閉じる」を使用します。
- サイトやエクスペリエンスを離脱する場合は「離脱」を使用します(「Report Builderを離脱」など)。
- ナビゲーションには「移動」または「移動」を使用します。
- 「ビデオを見る」ではなく「ビデオを再生」を使用する 誰もが見ているわけではありません。
- 「すべてを表示」ではなく、「表示」、「表示」、「すべてを表示」のいずれかを使用します。 誰もが見ているわけではありません。
- 「ログイン」/「ログアウト」ではなく、「ログイン」/「ログアウト」を使用します。
- “ in order to ”を避ける。 代わりに「to」を使用してください。
- 「利用」は避ける。 代わりに「use」を使用してください。
- 「速い」や「簡単」などの曖昧な形容詞は避けます。 正確に言うと、「このプロセスには通常5分かかります」。
- 弱い副詞を避ける:非常に、非常に、信じられないほど。
文章と段落構造
- 1文あたり≤20語をターゲットにします(オーサリングガイドでは≤35語まで)。 一文に一つの考え。
- 段落:最大125語、理想的には≤100。 最大4から5個の文章。 テキストの壁はありません。
- アクティブな声を使う。 パッシブな構成やノミネーションを避ける(例えば、「作成」ではなく「作成」を使用する)。
- シンプルなsubject-verb-object構造を使用します。
- 偽物の被写体を避ける(「ある…」、「ある…」)。
- 一貫して同じ言葉を使う。 同義語を回転させないでください。
- ユーモア、スラング、専門用語、文化固有の例は避けましょう(適切にローカライズする必要があります)。
- 3つ以上の項目のリストでOxford コンマを使用します。
- 整数は0から9までの範囲でスペルアウトします。10以上の数字を使用してください。
- セミコロンはありません。 代わりにピリオドと新しい文を使ってください。
スキャン可能性
- 読者は、タイトル、見出し、キャプションのみから、記事の範囲を把握する必要があります。
- セクションごとに最大2~5個のサブセクション。
- 目標はタスクごとに7 ステップで、10 ステップが現実的な最大値です。 より長い手順をサブタスクに分割する:
- 箇条書きリストごとに最大8項目。
- 用語/定義リストをスキャンしやすくするために、テーブルを使用します。
- コンテンツは、読みやすさテストで10点未満である必要があります(固有名詞とタイトルを削除した後)。
AI発見のための執筆
AI アシスタントと検索ツールは、生成された回答の中からExperience Leagueのコンテンツをますます見つけやすくなっています。
- 画像や複雑な表だけでなく、本文やリンクテキストに主要な用語(製品名、機能名、タスク)を含めます。 AI システムは読みやすいテキストに依存します。
- 明確な自己完結型の見出しと最初の段落を作成する。 AI ツールは、多くの場合、これらを切り離して抽出します。AI ツールは、コンテクストを取り巻くことなく、意味のあるものでなければなりません。
- 文章は短く、直接的に書く。 AIが簡潔な文章を作成することで、AIが正確に分析し、引用しやすくなります。
- 手順と比較には、構造化形式(番号付き手順、短い箇条書き、定義スタイルの見出し)を使用します。 構造は、AIが正解を識別するのに役立ちます。
- 様々なクエリフレーズの取得を改善するために、最初に使用する際に類義語または代替用語(例:「ECID (Experience Cloud ID)」)を含めます。
- メタデータフィールド(タイトル、説明、機能タグ)が完全で正確であることを確認します。
---
2. Adobe Markdown構文(Experience League)
Frontmatter (すべてのファイルに必要)
---
title: Title Case Title Here
description: Learn how to... or Learn about... (150-160 chars, sentence case).
---
このリポジトリで使用されている追加のオプション フィールド:solution、type、role、exl-id。 既存のファイルのパターンを一致させます。
重要:新しいページの作成時にexl-idを追加しないでください。 公開時に自動的に生成されます。 既存のページに既に存在するexl-id フィールドのみを保存する必要があります。
タイトルメタデータルール:
- タイトルケース(タイトルケースを使用するExperience Leagueでのみ使用)。
- 最大60文字(英語)。 システムは
| Adobe Experience Platformを自動的に追加します。 それを長さに分解する。 - パイプ名や製品名は追加しないでください。 自動的に追加されます。
- それは、ページ名(ユーザーが検索するコンテンツ)のSEO バージョンだと考えてください。
- コンセプトタイトル:名詞(例:「ページビューレポート」)
- タスクタイトル:動詞フレーズ(例:「ページビューのセグメントを作成」)。
- 頭字語は、ほとんどの用途でマーケティング部門によって承認されていませんが、SEO、目次エントリ、説明メタデータ、および長さが懸念される見出しについては、限定的な使用が許可されています。
説明メタデータルール:
- 文頭のみ大文字。 150 ~ 160文字(理想的)、最大160文字。
- 1から2つの簡潔な文章。 最初の文は要約し、2番目はcall to actionです。
- コンセプトの説明を「詳細を見る…」から始める または「理解する…」
- 「次の方法を学ぶ」でタスクの説明を開始します。 または必須動詞があります。
- 製品名で始めてはいけません。 SEOの動詞から始めます。
- 最初の段落のテキストをコピーしないでください(目的が異なります)。
- メタデータフィールドが
[!DNL]または`` タグで始まる場合、フィールド全体を引用符または検証で囲むと失敗します。
見出し
#= H1 (記事タイトル、ページごとに1つ)。##= H2 メインセクション。###= H3など。- 見出しレベルをスキップしないでください(例えば、H2からH4にジャンプしないでください)。
- ≤5単語をターゲットにする。 最大69文字(英語)。
- すべての見出しの前後に空白行を作成します。
- すべての見出しの後には、本文の文が少なくとも1つ続く必要があります。 2つの見出しを重ねたり、段落のない見出しの下にメモ、リスト、またはテーブルを直接配置したりしないでください。
- カスタムアンカーID:
## Section title {#section-id}(小文字、ハイフネーション、ピリオドなし)。 - JavaScript/CSSと競合するアンカー名(検索、結果、コンテンツ、ヘッダー、フッター、ナビゲーション、サイドバー、ページネーションなど)は使用しないでください。
- 見出しテキスト内にバッジやMarkdown要素を配置しないでください。
- 「概要」や「概要」などの単語抽象見出しのみを使用しないでください。 概要や概要を説明する必要があります。
- H1を数えないでください。 チュートリアルについては、「手順1: ...」を使用してください。 番号の付いたアンカーではなく小見出しで使用します。
- すべての見出しに文頭のみ大文字(固有名詞とUI要素は除く)を使用します。
- コンセプト見出し:名詞と名詞のフレーズ(例:「セグメント化の概要」)
- タスク見出し:必須動詞(「ターゲティングワークフローの作成」など)。 名目( – ing フォーム)は避けます。
- -mentまたは – ionで動詞を命名することは避けます(「ロードマップ作成」ではなく「ロードマップ作成」を使用します)。
- セクション内で見出し構造を平行に保ちます。
- 文書内に重複する見出しアンカーIDはありません。
- 見出しに数字が含まれる場合は、数字で始まらない明示的な見出しIDを指定します(例:
## Release notes for 2016 {#release-notes-2016})。
リンク
- 内部相互参照:
/help/で始まるルート相対パス:[link text](/help/path/to/file.md) - アンカーへのディープリンク:
[text](/help/path/to/file.md#anchor-id) - 外部リンク (このリポジトリ外):絶対
https://URL。 これらは自動的に新しいタブで開きます。 - 新しいタブで明示的に開く:
{target="_blank"}を追加します(クロスガイドリンクに使用)。 - 参照リンク (
[1]: urlスタイルを使用):絶対URLでのみ動作します。 - 目次に同じファイルを複数回追加しないでください。
- 本文のURLは未加工のものを使用しないでください。 必ずわかりやすいリンクテキストを使用する。
- リンクテキストとして「ここをクリック」または「リンク」を絶対に使用しない。 スクリーンリーダーは、コンテキスト外のリンクを表示し、複数の「ここをクリック」インスタンスを区別することはできません。
- リンクテキストは、リンク先を明確にする必要があります。
- 「詳細」相互参照リストの場合は、箇条書きリストで
More help on this topicの小見出しを使用します。
画像
- 構文:
 - サイズ変更:
{width="300"}または{width="50%"} - 整列:
{align="center"}または{align="right"} - ズーム可能:
{zoomable="yes"} - モーダル表示:
{modal="regular"}。 リンクと結合しないでください。 - 推奨される幅:640 ~ 2000 px 最大ファイルサイズ:5 MB推奨、100 MBのハード制限。 1記事につき最大100枚の画像。
- 画像は、マークダウンファイルに対して
assets/サブフォルダーに配置されます。 - ローカライズできない画像は、
do-not-localize/サブフォルダーに移動します。 - ダークテーマではなく、Experience Cloud製品UIのLight テーマを使用して、スクリーンショットを常に撮影します。
- スクリーンショットに顧客データを表示しない。
- スクリーンショットにサードパーティインターフェイスを文書化しないでください。 代わりに、サードパーティのドキュメントにリンクしてください。
- スクリーンショットを使用して、画面の進行状況を追跡したり、明らかなUI要素を表示したりしないでください。
- 簡単に識別できるアイコンのイラストは、記事ごとに1回以上含めないでください。
- コードの画像は使用しないでください。 代わりにコードブロックを使用してください。
- 情報を伝えるために色だけを使用しないでください(色覚障害のあるユーザーにはアクセスできません)。
- 1秒間に3回以上フラッシュするアニメーショングラフィックを使用しないでください(発作リスク)。
- 画像のコントラストが良く、明確であることを確認します。
- スクリーンショットのピクセルサイズのガイドライン:大きい場合は最大2000 px、中の場合は672 px、小さい場合は300 px、アイコンの場合は30 ~ 35 px
- コールアウトの場合:赤い16進数#EB1000、3 pxの線の太さ、8 pxの角の半径を使用します。
代替テキスト
代替テキストは、Googleによってインデックス付けされ、スクリーンリーダーによって読み取られます。 いつも注意深く書きなさい。
- 画面名だけでなく、画像が示す内容も説明します。
- 適切な文法と句読点で完全な文章を使用してください。
- 画像の関連テキストを含めます。
- 略語ではなく完全な単語を使いましょう。 スクリーンリーダーは省略形を綴ります。
- 「この画像が示す…」で始めてはいけません。 コンテンツを直接記述するだけです。
- 代替テキストは通常、純粋に装飾的な画像には必要ありませんが、不明な場合は提供してください。
| 適切な代替テキスト | 回避 |
|---|---|
| 地域と年齢のデモグラフィックフィルターが選択されているオーディエンスビルダーのスクリーンショット。 | オーディエンスビルダー |
| 拡張機能カタログから拡張機能を選択します。 | 拡張機能ライブラリ |
動画
- 構文:
>[!VIDEO](https://video.tv.adobe.com/v/xxxxx/?quality=12&learn=on) - すべてのビデオ URLの末尾に
?quality=12&learn=onを追加して、最適な再生を行います。 - 動画は自動再生できません。 ドキュメントに
?autoplay=trueを追加しないでください。 - 「書面による指示については、[link]を参照してください。」という代替テキスト、トランスクリプト、または書面による指示へのリンクを必ず入力してください。
- 意味のあるキャプションを使う:
- 個々のビデオで
{transcript=true}の文字起こしを有効にするか、ガイド全体でauto-video-transcripts: trueをTOC.mdに追加します。
注意と注意
>[!NOTE]
>
>Note content here.
>[!TIP]
>
>Tip content here.
>[!IMPORTANT]
>
>Important content here.
>[!WARNING]
>
>Warning content here.
>[!CAUTION]
>
>Caution content here.
その他のタイプ:[!ADMIN]、[!AVAILABILITY]、[!PREREQUISITES]、[!INFO]、[!ERROR]、[!SUCCESS]。
重要な構文ルール:
- タグ行とコンテンツの間に空白の
>行が必要です。 - すべての継続行は
>で始まる必要があります。 - ブロック引用の構文(
>タグなし)はサポートされていますが、プレーンブロック引用としてレンダリングされます。 スタイル設定されたコールアウトを想定して使用しないでください。 - 箇条書きリスト、特にネストされた箇条書きリストなどのブロック コンポーネント内にコメントを追加しないでください。 コメントは、リストのレンダリング方法を変更できます。
タブ
>[!BEGINTABS]
>[!TAB Tab label]
Tab content here.
>[!TAB Another tab]
More content.
>[!ENDTABS]
- タブセットはネストしないでください。
- リスト内にタブセットをネストしないでください。
- タブタイトルは、太字または斜体で書式設定できません。
- ページ内検索(Ctrl+F)で、非表示タブにコンテンツが見つかりません。
折りたたみ可能なセクション
+++Click to expand
Content here.
* Bullet one
* Bullet two
+++
- 折りたたみ可能な範囲内で、リストとコードブロックの上下に空白行を追加します。
- 折りたたみ可能なセクションは、折りたたみ可能なセクション内にネストしないでください。
- 折りたたみ可能な内部の見出しは許可されていますが、推奨されていません。
- 注意:「ページ内で検索」(Ctrl+F)を選択すると、Chromeでは折りたたまれたテキストが検出されますが、Safariでは検出されません。
シェードボックス
>[!BEGINSHADEBOX "Optional Title"]
Content with gray background.
>[!ENDSHADEBOX]
コードブロック
- インライン:シングル バックティック
`code`。 Cookie名、ファイル名、値、パラメーター、コマンド、検証しないサンプル URLに対して使用します。 - フェンス付きブロック:言語識別子を持つ3つのバックティック(構文の強調表示とコピーボタンを有効にする)。
- オプションの属性:
{line-numbers="true"}、{start-line="7"}、{highlight="11-13, 16"} - コードブロックはローカライズされていません。 DNLやUICONTROLを追加する必要はありません。
- コード、ファイル名、パラメーター、および入力されたテキストには、バックティック(引用符ではなく)を使用します。
- コードの画像は使用しないでください。 常にコードブロックを使用しましょう。
バッジ
- インライン:
[!BADGE Beta]{type=Informative} - メタデータ (H1より上):
badgePremium: label="Premium" type="Positive" - 種類:
Informative(青)、Positive(緑)、Negative(赤)、Neutral(濃いグレー)、Caution(黄色) - 記事ごとにメタデータのバッジを最大2個指定できます。
- 見出しにバッジを付けないでください。
- すぐに古くなった情報(例:「新規」)にはバッジを使用しないでください。
- バッジラベルはローカライズされています。 簡潔に。
- ベータ版バッジの場合は、frontmatter
badgeBetaのみを使用してください。 H1にインラインバッジを配置しないでください。 - バッジ URLを新しいタブで開く場合は、バッジの構文に
newtab=trueを追加します。
リスト
- 1つの記事で
*または-を一貫して使用します。 既存のファイルの規則を確認します。 マーカーを混在すると、検証エラーが発生します。 - 番号付きリストの場合は、各項目に
1.を使用します。 GitHub/EDSは正しく自動番号を付けます。 - 箇条書き:順序が重要でない場合。 番号付きリスト:手順と順序付き手順について。
- 1段階の手順では、
1.の代わりに箇条書き(*)を使用します。 - リスト入力を簡潔にする: 通常は1文かそれ以下。
- 完全な文章にはピリオドを使用し、単語入力または不完全な文章の入力にはピリオドを省略します(リスト内で一貫してルールを適用します)。
- セミコロン、コンマ、および「および」や「または」のような接続語でリスト項目を終わらせないでください。項目が単純なシリーズとして読まれることを意図しています。
- すべてのリストエントリは文法的に並列である必要があります。
- ネストされたコンテンツのインデント:番号付きリストの場合は3つのスペース、箇条書きリストの場合は2つのスペース。
- リストを空白行で囲む。
- タスクリスト(GitHub スタイル
- [ ]チェックボックス)は使用しないでください。 Experience Leagueではサポートされていません。
テーブル
- 標準のマークダウンテーブルを使用します。
- 複雑なレイアウト (結合されたセル、境界オフ)の場合は、HTML
<table>を使用できます。 - 表を空白行で囲む。
- 必要に応じて、自動幅テーブルに
{style="table-layout:auto"}を使用します。 - 表のセル内のスクリーンショットは避けます。 小さなアイコンやサムネールはセルで使用できます。
プレビュー機能のハイライト
インラインプレビューコンテンツにはスパンを使用し、複数段落プレビューコンテンツにはdivを使用します。
<span class="preview">This feature is in limited availability.</span>
<div class="preview">
Multiple paragraphs of preview content here.
</div>
スニペットとインクルード
{{$include /path/to/snippet.md}}
複数の記事で共有される、再利用可能なコンテンツブロックに使用できます。
特殊文字
- 本文の特殊文字をバックスラッシュでエスケープ:
\#、\*、\[、\]。 - 山形かっこにはHTML エンティティを使用:
<、>、&。 - 特殊記号にHTML エンティティを使用:
®、—、–。
コメント
HTMLのコメントを使用して、下書きテキストまたは他のライターへのメモを作成します。
<!-- This is a comment. Not rendered in the published doc. -->
GitHub.comで編集しているユーザーにはコメントが表示されます。 コメントに機密情報を含めないでください。
箇条書きリスト(特にネストされた箇条書き)などのブロック コンポーネント内にコメントを追加しないでください。 コメントはリストのレンダリングを解除できます。 目次.md ファイルでは、目次リストの中央にある行をコメントアウトしないでください。代わりに、ファイルの最後にコメントを移動します。
キーボード操作
キーボードショートカットの各キーを太字にする:cmd + shift + p。
ファイルとフォルダーの命名
- Markdown ファイル名:ハイフン付きの小文字。 大文字、アンダースコア、ピリオド、スペースは使用できません。
- 記述的なスラグを使用:
create-calculated-metric.md、calculated-metric-overview.md。 IAで固定名が必要な場合を除き、overview.mdやintroduction.mdなどの裸のファイル名は避けてください。 - JavaScript/CSSと競合するファイル名は避けてください:
metadata.md、search.md。 - アセットファイル名:小文字を優先。大文字とアンダースコアは使用できますが、使用は推奨されません。
---
3. ローカリゼーションタグ (クリティカル)
ローカライゼーションタグを常に適用する。 機械翻訳は、メインへのコミットごとに自動的に実行されます。
[!DNL Product Name]: ローカライズしない
英語のままにする必要があるブランド製品名に使用します。
適用先:
- Adobeの商品名:
[!DNL Analytics]、[!DNL Target]、[!DNL Campaign]、[!DNL Experience Platform] - サードパーティ製品名:
[!DNL Mozilla Firefox]、[!DNL Workfront] - 翻訳を混乱させる機能名:
[!DNL Pass]、[!DNL Campaign] - 論理用語として使用されるブール演算子:
[!DNL AND]、[!DNL OR]
に適用しない:
- URL、ファイル名またはディレクトリ名
- コードブロック (デフォルトではローカライズされていません)
- 頭字語(自動的に英語に留まる)
- 翻訳しないデータベースに既に含まれている用語
リンクテキスト内: レンダリングの問題を防ぐため、タグブラケットを削除します。 [[!DNL Adobe]](https://www.adobe.com/jp)ではなく[Adobe](https://www.adobe.com/jp)を使用してください。
[!UICONTROL Label]: UI コントロール
インターフェイス要素に対して使用します。UIに表示されるオプション、フィールド、タブ、ページ、メニュー、ボタン、および機能名です。 翻訳の品質を高めるために、最も重要なタグです。 手順では必須として扱います。
適用先:
- 手順ステップのクリック可能なUI要素(必須)
- 製品に表示されている機能名とナビゲーション要素
- インターフェイスのラベルに従ったページ名、オプション、フィールド、タブ
書式設定:
- 手順とナビゲーションの太字:
Select **[!UICONTROL Destinations]** from the left navigation. - 明瞭化のために、概念テキスト(非ステップ)で使用できる斜体です。
- HTML テーブルの場合:``の代わりに
<span class="uicontrol">term</span>を使用します。 - リンクテキスト内:タグブラケットを削除します。
大文字: インターフェイスと完全に一致します。
に適用しない:
- 概念的に使用される一般的な用語:「セグメント」、「指標」、「キャンペーン」(UI要素を明示的に参照する場合のみタグ)
- 長い文章(UI要素名自体が長いフレーズでない限り)
- コードブロックまたは頭字語
- アイコンの説明: 使用可能な場合は、アイコンのホバー/ツールチップ名を使用します。「鉛筆アイコン」などの一般的な説明にはタグを付けないでください
[!DNL]: セクション全体を除外
すべてのロケールで英語のままにする必要があるコンテンツをラップします。
>[!DNL]
>
>Content that must not be translated.
コードブロック内は必要ありません。 これらはデフォルトではローカライズされていません。
タグを使用できる場所と使用できない場所
次の場所で使用できます:段落、リスト、見出し、表、バッジ、代替テキスト、メタデータ。
次の個のコードブロック、略語で使用できません。
メタデータルール: メタデータフィールド(タイトルまたは説明)が[!DNL]または`` タグで始まる場合、フィールド全体を引用符または検証で囲むと失敗します。
---
4. 情報構造とコンテンツタイプ
3つのコンテンツタイプ:それらを分離します
- 概念:何とその理由。 概要、概要、背景。 名詞や名詞の見出しを使う:
- タスク:方法 ステップバイステップの手順。 必須動詞の見出しを使用します。 常にコンセプトが先行します。
- 参照: フィールド、パラメーター、オプション、エラーコード。 テーブルの使用: その他の参考資料と共に収集。
記事の構造
- 読者の方向を示す概念的なコンテキストで開きます。
- 次にタスクに移動し、次に資料を参照します。
- 各ページで焦点を絞った質問をひとつ用意します。 広すぎず、狭すぎず。
- コンセプトページと子タスクページ(マルチページ)、またはH1 コンセプト + H2 タスクの小見出し(単一ページ)。
- 類義語や以前の名前を一度導入すれば(例:「ECID (Experience Cloud ID)」)、検索語をつなげることができます。
手順
- 各ステップは単一のコマンドです。ピリオド(サブリストを導入する場合はコロン)付きの完全な文です。
- 手順は常に動詞またはアクションの前の目標から始まります。「レポートを実行するには、実行」を選択します。
- UI内の同じ場所で実行される小さなアクションを、文が明確に保たれる場合に1つのステップに組み合わせます。
- 目標はタスクごとに7 ステップで、10 ステップが現実的な最大値です。 長いタスクをサブタスクに分割する:
- 手順が1つしかない場合は、1つの箇条書き(
1.ではなく)を使用します。 - 製品ドキュメントの手順として見出しを使用しないでください。 長いマルチページチュートリアルの場合は、必要に応じて「手順1: ...」スタイルの小見出しを使用します。
- ステップの後の新しい行にインデントされたステップ情報(説明テキスト)を配置します。
- 画面を表示する手順またはアクションの後にインデントされたスクリーンショットを配置します。
- ページ、タブ、パネル名を手順を繰り返して、読者がその場所を把握できるようにします。
目次ファイル(TOC.md)
- すべてのエントリに対する文頭のみ大文字(固有名詞とUI要素は除く)。
- コンセプトエントリ:名詞と名詞フレーズ。
- タスクのエントリ:必須動詞(ガルンドではない)。
- エントリを平行に保ちます。
- 目次のすべてのセクション見出しには、有効なアンカーIDが必要です:
+ Processing rules {#processing-rules} - 目次のセクション見出し(親)をリンクにすることはできません。 アンカーIDが必要です。
- 目次に同じファイルを複数回追加しないでください。
- 目次リストの中央にある行はコメントアウトしないでください。 ファイルの最後にコメントを移動します。
ナビゲーションからファイルを非表示にする
すべての新しい作業にV2 メソッドを使用します。 V1 メソッドは非推奨です。
V2 (現在): TOC.mdの{hide-from-toc}
非表示にする記事またはセクションの前のTOC.mdに{hide-from-toc}を直接配置します。 それを記事のフロントマターに追加しないでください。
+ {hide-from-toc} [Article title](filename.md)
+ {hide-from-toc} Section name {#section-id}
+ [Nested article](nested.md)
- 非表示の記事は直接URLからアクセスできます。
- エントリがすべて非表示になっているセクションは、左側のナビゲーションから消えます。
V1 (非推奨): hidefromtoc: yes in frontmatter
hidefromtoc: yes
新しいページでは使用しないでください。 記事は引き続きTOC.mdに表示して公開する必要がありますが、左側のナビゲーションには表示されません。
検索エンジンから非表示:hide: yes in frontmatter
hide: yes
これにより、外部および内部の検索からページが除外されます。 hide: yesを設定すると、index: noが自動的に設定されます。 ナビゲーションと検索の両方からページを非表示にする場合は、{hide-from-toc}に加えてこれを使用します。
---
5. 用語とブランディング
信頼できる情報源:AEP User-Facing Terminology wiki。 最新バージョンについては、常にConfluence MCP ツール (mcp__adobe-wiki-confluence)を通じて確認してください。
製品名
常に正確なフォームを使用する: ガイドの最初の参照に「Adobe」を含めます。ポリシーで許可されている場合は、後続の説明に追加できます。
製品名の前に「を」を付けないでください(正式名称に記載されている場合を除きます)。
- 正解:「AI アシスタントの基本を学ぶ」
- 「AI アシスタントを使い始める」が正しくありません。
| 正確 | 使用しない |
|---|---|
| Adobe Experience Platform | AEP、AXP、Adobe XP、Adobe Cloud Platform |
| Experience Platform(二次資料) | Platform (単独、コンテキストが明確でない場合を除く) |
| Adobe Real-Time CDP | RTCDP、ARTCDP |
| Real-Time CDP (セカンダリ) | Real-time CDP (小文字は「t」) |
| Adobe Real-time Customer Data Platform | — |
| リアルタイム顧客プロファイル | リアルタイムの顧客プロファイル、統合プロファイル |
| Adobe Journey Optimizer | AJO |
| Adobe Journey Optimizer B2B Edition | AJO B2B |
| Adobe Marketo Optimizer | AMO |
| Adobe Marketo Engage | Marketo(形容詞としては使用できません) |
| Adobe Customer Journey Analytics | CJA |
| Customer Journey Analytics (セカンダリ) | — |
| Adobe Real-Time CDP Collaboration | Collaboration、RTCDP研究室、研究室 |
| Adobe Real-Time CDPとの連携 | RTCDP Connections、AEP Connections、Connections (単独) |
| Adobe Experience Platform Edge Network | Platform Edge Network、Platform Edge、Adobe Experience Edge |
| タグ(製品名) | 起動(非推奨) |
| 意思決定管理 | Offer Decisioning(括弧のみ:「旧Offer Decisioning」) |
| データストリーム (1単語、小文字) | データストリーミング,エッジ設定 |
| Analysis Workspace | analysis workspace, workspace, Workspace |
| Adobe AI | Sensei (非推奨) |
| Adobe GenAI | — |
| Adobe GenStudio for Performance Marketing | — |
「Real-Time」は、商品名の一部(Real-Time CDP、Real-Time Customer Profile、Real-Time Customer Data Platform)の場合、常に大文字Rと大文字Tを使用します。
Editions:「エディション」は一般的に小文字です。「エディション」は製品版名の一部として大文字で表記されます(例:「Adobe Real-Time CDP B2C Edition」)。
外部コミュニケーションの略語:ユーザー向けドキュメントでは、製品名を略語にしないでください。 AEP、CJA、AJO、RTCDPはドキュメントに含まれていません。 制限付き例外:頭字語は、SEOに役立つ場合や、目次エントリ、説明メタデータ、長さが懸念される見出しに使用する場合、括弧で囲んで表示されることがあります。
機能と概念に関する用語
| 正確 | 使用しない |
|---|---|
| イベント転送 | サーバーサイド転送、ローンチサーバーサイド |
| ⌥許可リストに加える | ホワイトリスト |
| ⌥ブロックリスト/{ | ブラックリスト |
| プライマリ/レプリカまたはプライマリ/セカンダリ(サーバー) | マスター/スレーブ |
| main (GitHub ブランチ) | マスター |
| 倫理ハッカー | ホワイトハットハッカー |
| リマーケティング | リターゲティング |
| フィールドグループ | mixin (非推奨)、拡張機能、Mixin |
| データの自動有効期限 | TTL、有効期間、有効期限 |
| 実稼動以外のサンドボックス | ステージング (環境名として) |
| セグメント定義 | セグメント(定義を意味する場合は単独) |
| ID (常に大文字) | ID |
| 取り込み/取り込み/取り込み | オンボーディング(Platformへのデータ追加用) |
| データセット/データセット | データファイル、データセットファイル |
| アクセス制御 | 権限(プラットフォーム機能の) |
| widget | 指標カード (非推奨) |
| プレースホルダー変数 | ダミー変数 |
| 利用できない/ロック済み/無効/非アクティブ | グレー表示 |
| 一貫性チェック | サニティチェック |
| ビルトイン | ネイティブ(ビルトインの同義語として) |
| 優先度:高 | ネイルが必要 |
| レガシー | 祖父 |
| プライマリ/メイン/ソース | master (記述子として) |
Analytics固有の大文字と小文字:
- パネル名は小文字です。空白、アトリビューション、実験、フリーフォーム(例外:「ジャーニーキャンバス」)
- ビジュアライゼーション名は小文字です:棒グラフ、ドーナツグラフ、ヒストグラム、線、ツリーマップ、テキスト
社内利用条件:公開ドキュメントでは絶対に使用しない
これらの用語は、Jira、Wiki、および内部ディスカッションに表示されますが、ドキュメントには絶対に表示されません。
| 内部用語 | 代わりに使用 |
|---|---|
| AEP | Adobe Experience Platform |
| 手のひら | サンドボックス管理/アクセス制御 |
| バイオーム | environment |
| 水和物/水分補給 | 作成/入力 |
| 統合プロファイル | リアルタイム顧客プロファイル |
| ステージング(環境) | 実稼動以外のサンドボックス |
| DTM | タグ |
| テナント | IMS組織/組織 |
| CRUD | 作成、読み取り、更新、削除(スペルアウト) |
| Siphon、BSO、Ethos | 内部コード名。外部コードは使用しない |
| ホップ | 内部GDPR/アクセス制御用語 |
| ペーシング | 非ユーザー向け広告用語 |
| パイプライン | 内部Adobe インフラストラクチャ用語 |
---
6. 包括的な言語とアクセシビリティ
包括的な言語原則
- 性別に依存しない用語を使用する:「営業担当者」は「セールスマン」ではなく、「モデレーター」は「議長」ではありません。
- 性別による代名詞を避けるには、2人目(「あなた」)を好みます。
- 性別が不明な人に対しては、単一の「they」を使用します。 彼/彼女または(s)彼を使用しないでください。
- 例えば、非白人文化からの名前を含めます(例:Ayesha、Ibrahim、Vignesh、Quynh)。 「文化的に白い名前(ジョン、ビル、カレン、エイミー)のみを使用しないでください。
- 性別(男性/女性)と性別(男性/女性)を混同しないでください。
- 国籍、民族、人種(「白」以外)、および部族を大文字にします。
- 人を第一に考える言葉を使う:「障害者」ではなく「支援テクノロジーを使う人」
- 「別の方法で有効にする」などの婉曲表現を避けます。 「盲人」、「聴覚障害者」といった名詞は避けましょう。
- アイデンティティ(文化的流用)を反映する用語を避ける:精神動物、シェルパ、ポウ・ワウ、グル、忍者、部族。
回避すべき非包括的な用語
| 用途 | Not |
|---|---|
| 許可リスト/ ブロックリストに加える/ ブロックリストに加える | ホワイトリスト/ブラックリスト |
| プライマリ/レプリカまたはプライマリ/セカンダリ | マスター/スレーブ |
| main (git ブランチ) | マスター |
| 優先度:高 | ネイルが必要 |
| プレースホルダー変数 | ダミー変数 |
| 利用できない/ロック済み/無効/非アクティブ | グレー表示 |
| 一貫性チェック | サニティチェック |
| ビルトイン | ネイティブ(同義語として) |
| 権威/エキスパート | グル/ニンジャ |
| グループのメンバー | あなたの部族のメンバー |
| 会議 | ポウ・ワウ / サークル・ザ・ワゴン |
| ロールモデル/kindred spirit | 霊動物 |
| ガイド | シェルパ |
| レガシー | 祖父 |
| 無益な事業 | 死の行進 |
| ばかげている/無能/予測不可能 | バム/ラメ/クレイジー |
| 倫理的/非倫理的なハッカー | 白い帽子/黒い帽子ハッカー |
| ビデオを再生 | 動画を見る |
| 表示/表示/すべてを表示 | すべて見る |
アクセシビリティ:UIの説明
UI要素を色や画面の位置で説明しないでください。 色覚に問題があるユーザーやスクリーンリーダーでは、カラーは機能しません。 支援テクノロジーでは、画面の位置が信頼できません。
時系列言語を使用します。空間言語は使用しません:
| 用途 | Not |
|---|---|
| まず、次に、最後に | 上、下 |
| メニューバーの | 左側には |
| 適用前/適用後 | 画面の上部/下部 |
コントロールの表示方法を説明します。コントロールの表示方法は説明しません:
| 用途 | Not |
|---|---|
| 検索を選択 | 虫眼鏡アイコンをクリックします |
| 編集 | 鉛筆アイコン |
| オン/オフ | 切り替え/切り替え/アクティブ化 |
| メニュー | サイドドロワー |
| メールの入力 | メールアドレスを入力 |
| 保存 | 「保存」ボタン |
| キャンセル | 閉じる |
情報を伝えるために色だけを使用しないでください。 カラーは必ずテキストまたはシェイプと組み合わせてください。
アクセシビリティ:代替テキスト
- スクリーンネームだけでなく、画像が示す内容も説明します。
- 適切な文法と句読点で完全な文章を使用してください。
- 画像の関連テキストを含めます。
- 略語ではなく完全な単語を使いましょう。 スクリーンリーダーで略語が読み上げられる。
- 周囲のテキストに依存せずに情報を伝える画像には、代替テキストが必要です。
- 純粋に装飾的な画像では代替テキストが省略される場合もありますが、含めることが推奨されます。
- 色を使用して意味を伝える場合は、色弱シミュレーターで画像をテストします。
- 1秒間に3回以上フラッシュするアニメーショングラフィックを使用しないでください(発作リスク)。
アクセシビリティ:リンク
- リンクテキストとして「ここをクリック」または「リンク」を絶対に使用しない。
- リンクのテキストだけで宛先を明確にします。
- 良い:「RTCDP ユーザーガイドのRTCDPの前提条件を参照してください。」
- 悪い:「前提条件については、ここをクリックしてください」
アクセシビリティ:ビデオ
- 動画は自動再生できません。
- 必ず、代替テキスト、トランスクリプト、または書面による指示へのリンクを提供してください。
- すべての動画に有意義なキャプションを配置する。
- 可能であれば、手書きの指示へのリンク:「手書きの指示については、[link]を参照してください。」
---
7. スペルと句読点
アメリカ英語のスペル
| 用途 | Not |
|---|---|
| 色 | カラー |
| 認識 | 認識 |
| ライセンス | ライセンス |
| while | while |
| 有効期限 | 有効期限 |
| メーター | メーター |
| 間で | Among |
句読点の規則
- 閉じる引用符は、コンマやピリオドの外に出ます。
- 引用符を引用符で囲みます。 UI文字列を引用符で囲まないでください(手順ではUICONTROLと太字を使用します)。
- 用語として使用される用語には斜体を使用します(引用符は使用しません): プロファイル、「プロファイル」は使用しません。
- コード、パラメーター、ファイル名、入力されたテキストにバックティックを使用します:
datasetId。 - 太字:手順(UICONTROLを使用)のUI要素と、最初の導入時の主な用語に対してのみ使用します。 見出しレベルの質問を使用しないFAQ レイアウトでは、太字のリードラインを使用できます。
- 斜体:強調、外国語、定義されている用語、またはノンステップテキストの概念名の場合。
- 太字+斜体の組み合わせ:
***text***。 - 水平方向のルール (
---または***)は使用しないでください。 Experience Leagueではサポートされていません。 - em ダッシュ( – )、en ダッシュ( – )、またはハイフンを使用しないでください。 代わりに文を言い換えなさい。 ハイフンは、UI、ファイル名、コードに表示される複合形容詞でのみ使用できます。
- コロン:リストの導入に使用します。 全文が続くとき(または単語が適切な名詞であるとき)に、コロンの後の最初の単語を大文字にします。
- セミコロンはありません。 代わりにピリオドと新しい文を使ってください。
---
8. SEOと検索性
- 最初の段落に検索語(キーワード)を含めます。
- オーディエンスが実際に検索するキーワードを活用しましょう。 類義語や前任者名も参考になる場合に含めます。
- 見出しのキーワード:機能名、インターフェイス要素、実行されるタスクを含めます。
- 画像上の代替テキストは、Googleによってインデックス付けされます。 わかりやすく有意義なものにする:
- 複雑な表や画像にのみ重要な用語を配置することは避けてください(AIや検索で確実にインデックス付けされるわけではありません)。
- 説明メタデータ:キーワードには自然言語を使用します。 ランダムなキーワードを詰め込まないでください。 Googleは、キーワードスタッフィングのコンテンツを降格する場合があります。
- メタデータフィールド(タイトル、説明、機能タグ)を完全かつ正確に保つ:検出サーフェスでは、ページコンテンツを読む前にメタデータを使用して結果をフィルタリングおよびランク付けします。
---
9. ファイルとリポジトリの規則
.mdファイルごとにFrontmatterが必要です。- 画像は、マークダウンファイルに対して
assets/サブフォルダーに配置されます。 - ローカライズできない画像は、
do-not-localize/サブフォルダーに移動します。 - 目次ファイル (
TOC.md)は、左ナビゲーション構造を定義します。 ページを追加または削除する際に更新します。 - このリポジトリ内のドキュメント間の相互参照には、ルート相対リンク (
/help/...)を使用します。 - このリポジトリ以外のドキュメントへのリンクには、絶対
https://experienceleague.adobe.com/ja...URLを使用します。 - ブランチの名前:ユーザー名のプレフィックスがありません。 Jira チケット番号とタイトル付きのスラグ(例:
PLAT-12345-Update-Guardrail-Limits)を使用します。 ブランチとPR タイトルの両方に同じ形式を使用して名前を付けます。 - 個別のコンポーネント(見出し、フェンス付きコードブロック、リスト)は、空白行で囲む必要があります。
- ドキュメントごとに1つのH1 (
#)のみです。 前面物質の後の最初の行はH1でなければなりません。
---
10. チェックリストを見る
ドキュメントを確認または編集する際には、以下のすべての項目を確認してください。
声とスタイル
- ユーザー中心の音声。 「許可する」、「許可する」、「許可する」
- [ オーディエンスに直接アドレスを指定する際に、「ユーザー」の代わりに「あなた」が使用される]
- [ ]手順の2人目の人物と必須気分
- アクティブな音声
- [ ]個の文章のターゲット ≤20語
- [ ]あいまいな形容詞はありません(「高速」、「簡単」)。 正確な説明に置き換えます。
- AIの検出のために、本文テキスト(画像や表だけでなく)に主要な用語が表示される
構造と見出し
- [ ]見出し:文頭の大文字、≤5語 / 69文字、続いて本文、積み重ね見出しなし
- スキップされた見出しレベルがありません
- コンセプトの見出しは名詞フレーズです。タスクの見出しは必須動詞です
- タスクごとに7つのステップを目標にしてください。最大10個です。 1つの手順では、
1.ではなく箇条書きを使用します - [ 箇条書きリストごとに]個まで最大8項目
用語
- [ ]正しい製品名とフォーム (セクション 5)
- [ ]非推奨の用語はありません:mixin、TTL、Offer Decisioning、Launch、Unified Profile、Real-time (小文字t)、Sensei
- [ ]社内利用条件なし:AEP、PALM、BIOME、hydrate、ステージング、DTM、テナント、パイプライン
- [ ]包摂的条件なし:ホワイトリスト、ブラックリスト、マスター/スレーブ、サニティーチェック、ダミー、グレーアウト、ネイティブ、グル、忍者、スピリット動物、シェルパ、死の行進、捕虜、部族
- [ ]製品名の前に「the」が表示されない(例:「the Adobe Experience Platform」ではない)
ローカライズタグ
- [ すべてのUI要素名に] ``、手順は太字
- [ すべての製品名およびサードパーティ名に]
[!DNL] - [ タグ ]のブール演算子:
[!DNL AND]、[!DNL OR] - コードブロック内にタグがありません
- [ タグで始まる]個のメタデータフィールドは、引用符で囲まれます
Markdown構文
- [ ]修正された警告構文(タグとコンテンツの間に
>行が空白) - リストでは一貫したマーカーが使用され、番号付きリストではアイテムごとに
1.が使用されます - タスクリストがありません(
- [ ]) - [ ]水平ルールがありません(
---コンテンツ間) - [ 見出し、コードブロック、リスト、テーブルを囲む]行の空白
- コードの画像がありません。 コードブロックを使用します。
- [ ]件のスクリーンショットでLight テーマが使用されています。顧客データがありません。サードパーティ UIはありません
アクセシビリティ
- Alt テキスト:完全な文章、完全な単語、コンテンツの説明(画面名だけでなく)
- [ ]方向/空間言語なし:「上」、「下」、「左」、「右上」
- リンク テキストは宛先を表します。 「ここをクリック」はありません
- [ ]個の動画が自動再生に設定されていません。文字起こしまたは代替の手書き素材が提供されています
- [ ]情報を伝える単色は使用されていません
ファイルとリンク
- [ ]必要なfrontmatter: タイトル(タイトルケース、≤60文字)、説明(150~160文字)
- [ ]本文にURLが含まれていません。 必ずわかりやすいリンクテキストを使用する。
- ルート相対の内部リンク。相互参照用の絶対リンク
- ファイル名はハイフン付きの小文字です。説明的なスラグです(裸の
overview.mdではありません) - [
assets/の画像]、ローカライズされていない画像do-not-localize/
---
11. 外部参照
リソースタイプに基づいて正しいMCP ツールを使用します。
- Jira チケットとイシュー (
jira.corp.adobe.com): Corp Jira MCP ツール (mcp__corp-jira)を使用します - Wiki / Confluence ページ (
wiki.corp.adobe.com): Confluence MCP ツール (mcp__adobe-wiki-confluence)を使用します - パブリック Experience League / web ページ: WebFetchを使用
内部Wiki ページ (Confluence MCP ツールを使用):
- 用語wiki: https://wiki.corp.adobe.com/spaces/DMSArchitecture/pages/1230620427/Adobe+Experience+Platform+User-Facing+Terminology
- Platform スタイルガイド: https://wiki.corp.adobe.com/spaces/DMSArchitecture/pages/1938986972/Platform+style+guide
- アクセシビリティとインクルーシビティガイド: https://wiki.corp.adobe.com/spaces/DMSArchitecture/pages/2234798784/Writing+for+accessibility+and+inclusivity
- コンテキストヘルプポップアップガイド: https://wiki.corp.adobe.com/spaces/DMSArchitecture/pages/2575057078/How+to+add+contextual+help+popovers+to+the+Experience+Platform+documentation+and+UI
パブリック (WebFetchを使用):
- ローカライゼーションの概要: https://experienceleague.adobe.com/en/docs/authoring-guide/using/authoring/localization/localization-overview
- ローカライゼーションタグ参照: https://experienceleague.adobe.com/en/docs/authoring-guide/using/authoring/localization/localize
- Experience League Markdown構文: https://experienceleague.adobe.com/en/docs/authoring-guide/using/markdown/markdown-syntax
- Markdown チートシート: https://experienceleague.adobe.com/en/docs/authoring-guide/using/markdown/cheatsheet
- リリースノートのスタイル参照: https://experienceleague.adobe.com/ja/docs/experience-platform/release-notes/latest
ローカルクローン:
- オーサリングガイド リポジトリ: Adobe Experience League オーサリングガイドまたはその公開ドキュメントの利用可能なチェックアウトを使用します。
