トークンを含む説明テキストのベスト・プラクティス
次に、トークンを含むテキストを記述する際に留意すべきベスト・プラクティスをいくつか示します:
- 認識しやすいトークンに略語を含めます。
- トークンが何であるかを示すトークンの直前または直後に単語またはフレーズを挿入して、トークン化されたテキストを修飾します。
- 次に示すように、修飾子テキストとトークン名が一緒に意味を持つようにします。
ペア・リングが正しくない例 正しいペア・リングの例 タイム・カードは承認者 {STATUS}によって承認されました。 承認者 {APPROVER_NAME} がタイム・カードを承認しました。
請求書が承認され、 {STATUS} ステータスになりました。
- 説明が意味があるかどうかを確認するために、トークンなしで説明テキストを読みます。
- 数字にはトークンを慎重に使用してください。 時間数や時間タイプなど、オブジェクトである数値のトークンを修飾します。 トークンが単数形または複数形の金額を表す場合、テキストは両方のシナリオをサポートする必要があります。