製品内の固定リンクを作成する方法

Contributors Contributors 作成日:
This is a machine-generated translation of the English content. It has not been reviewed by a human, and may contain errors. If you would like to revise this content, you can start here.

エンジニアやプロダクトマネージャーが製品 (Firefox など) 内部から SUMO サポート記事へリンクする場合、直接の記事リンクではなく、常に固定 URL を使用するべきです。直接リンクは、記事のタイトルやスラッグが更新されると変更され、製品内リンクが壊れる原因となります。固定リンクはこれを防ぎ、ユーザーが常に正しいページにたどり着けるようにします。

この記事では、固定リンクが重要である理由、さまざまなプラットフォーム向けの書式、Kitsune ダッシュボードを使用した設定方法について説明します。

固定リンクが重要な理由

サポート記事への直接リンク (例: https://support.mozilla.org/en-US/kb/example-article) を使用すると、問題が発生する可能性があります:

  • リンクが壊れやすい: 編集者が手動でスラッグを保持しない限り、記事のタイトルが変更されると記事の URL も変更されます。
  • ローカライズできない: 直接リンクは言語をハードコーディングするため、海外のユーザーにとっては理想的ではありません。
  • 管理が難しい: 製品で直接使用されている場合、一括で更新することができません。

対照的に、固定リンクは:

  • 記事の URL が変更されても一貫性を保つ
  • 正しいロケールを自動的に検出する
  • 必要に応じて一元的にリダイレクトまたは更新できる

製品内サポート記事のリンク形式

デスクトップ製品およびモバイル製品向けの固定サポートリンクを構築するには、標準化された形式を使用してください:

注:

  • %VERSION%%OS%%LOCALE% は製品によって自動的に入力されます。
  • SUMO チームが <product><slug> フィールドを作成します。
  • <slug> は、作成した一意のスラッグに置き換えてください。

この形式により、ユーザーは正しくローカライズされた記事に誘導されます。

例:
https://support.mozilla.org/1/firefox/%VERSION%/%OS%/%LOCALE%/recommendations-firefox-new-tab

Kitsune で製品内固定リンクを設定する方法

固定リダイレクトを作成するには、Kitsune 管理ダッシュボードで以下の手順に従ってください。

固定リンクを作成するには、適切な権限を持つ Kitsune の管理者である必要があります。
  1. Kitsune 管理ダッシュボードにサインインします。
  2. INPRODUCT の下にある Redirects をクリックします。
  3. 右上の Add Redirect をクリックします。
  4. 以下の リダイレクトのフィールド のセクションで説明されているように、必須フィールドの ProductTopicTarget を入力します。
  5. SAVE をクリックします。
  6. 完成した固定リンクを、製品内形式を使用してエンジニアまたはプロダクトマネージャーと共有します:
https://support.mozilla.org/1/firefox/%VERSION%/%OS%/%LOCALE%/<slug>

リダイレクトのフィールド

フィールド 説明
Product デスクトップの場合は firefox、Firefox モバイル製品の場合は mobile を使用します。
Topic (slug)

記事の短く一意な識別子を入力します。これは固定リンクの一部になります。

  • 新しい記事 の場合: 新しいスラッグを作成します。
  • 既存の記事 の場合: 適切であれば、記事の現在のスラッグを使用します。
  • 小文字 (a–z) とダッシュ (-) のみを使用してください
  • #、アンダースコア、スペースなどの特殊文字を含めないでください
  • スラッグは、firefox-manage-account のように、シンプルで分かりやすいものにしてください
注: スラッグは、ターゲット記事の実際の URL と一致する必要はありません。製品での使用に適した、意味のある一貫したものを選択してください。
Target

リダイレクト先のサポート記事へのパスです。kb/ 以降の部分のみを含めてください。

例: kb/firefox-lockwise-managing-account-data

注: アンカー (例: kb/customize-items-on-firefox-new-tab-page#w_weather) を含めて、特定のセクションにリンクできます。アンカーは英語版でのみ機能し、他のロケールでは解決されない場合があります。

ヒント

  • 固定リンクはローカライゼーションを確実にします: ユーザーは、利用可能な場合、好みの言語に自動的にリダイレクトされます。
  • 固定リダイレクトは、後で Kitsune 管理インターフェイスを介して更新または削除できます。
  • 以下の場所からリンクする場合は、常にこの方法を使用してください:
    • 製品内の「詳細情報」メッセージ
    • オンボーディングフロー
    • エラーまたは警告メッセージ
    • コンテキストヘルプモーダル

以下の人々がこの記事の執筆を手伝ってくれました:

Illustration of hands

ボランティア

あなたの専門知識を成長させ、他の人と共有してください。質問に答えたり、ナレッジベースを改善したりしてください。

詳しく学ぶ