これは、ヘルプ センターで KCS 記事を作成するためのクイック リファレンス ガイドです。
送信する前に
1. お客様固有の情報を削除してください。
- 特定のお客様または特定の人物を特定できる情報
- お客様の環境を特定できる情報
2. 校正
- 技術的精度
- タイプミス、エラー
- 分かりやすいですか?
3. テンプレート設定の再確認
- テンプレートが「Fast Track」に設定されていることを確認してください
- これは記事の免責事項を適用するものです - 非常に重要です。
4. 表示設定を再確認する
- 適切な可視性設定を選択していることを確認してください: Everyone または Internal
- レビュー用の下書きとして保存する場合は、必ず 割り当て ボタンを使用して管理者 (Jay Lee) に割り当ててください。
タイトル
検索での見つけやすさを向上させるために、タイトルは顧客のコンテキストに記述する必要があります。
- お客様が問題を説明するために使用した言葉は?
- 問題に対する答えを探すために、顧客はどのような言葉を使用する可能性が高いですか?
- 技術的な専門用語や、顧客がまだ知らないソリューションに関する情報を使用してサポートを求めないでください。
例:
チケット | 悪いタイトル | 良いタイトル |
ABS-84 | 構成と権限 | コントロール パネルのサイト ページで Javascript を追加する機能を無効にする |
MSIP-21 | ページのエクスポートに関する制限事項 | LIFeray DXP ページを PDF にエクスポートできますか? |
2349 | DXP でのローカリゼーション | ローカリゼーションのためにフォームを翻訳する方法 |
問題
タイトルと同様に、お客様の言葉やフレーズで問題を説明します
- 顧客はチケットの問題についてどのように説明しましたか?
- 彼らが試して検索しようとしている症状、問題、または質問は何ですか?
直接的な言語を使用します。 不要な言葉をカット:
-
いいえ:
- 「お客様が印刷しようとしていた」
- 「プリンターから、無効なページであるというエラーが表示されました」
-
はい:
- 「ネットワークプリンターでファイルを印刷できません」
- 「ネットワーク プリンターがエラーを返しました: 「このプリンター ドライバーのページ レイアウトが無効です (24301)」」
環境
記事が解決しようとしている問題に具体的に影響を与える環境の詳細のみを含めてください。
Liferay バージョンの場合は、必ずバージョン番号を含めてください。
- いいえ: 「Liferay DXP」
- はい: "Liferay DXP 7.0、7.1"
環境の詳細は、明確かつ正確である必要があります。 含めることができる環境の詳細の例を次に示します。
ライフレイ製品 | フィックスパックまたはサービスパック | アプリケーション サーバー固有 | データベース固有 |
DXP7.0、7.1 | DXP7.0以上 | IBM WebSphere | MySQL |
Analytics Cloud | フィックスパック 33+ | WebLogic | MariaDB |
Commerce 1.0 | DXP 7.1 サービス パック 1 | JBoss EAP | SQL Server |
注: KCS の記事を見つけて、リストにない別のバージョンで有効であることを確認できる場合は、自分で追加してください (ラベルを含む)。
解像度
記事に記載されている問題に直接回答する必要があります。
- 既知の問題または LPS チケットを修正するフィックスパック
- 回避策
- ステップバイステップガイド
- 質問への回答
- リソースへのアクセス方法 (例: アクティベーション キーの取得方法)
直接的である - すべて現在時制のコマンドとして:
いいえ | はい |
「Liferay フィックスパック 60 をインストールした後...」 | 1. Liferay フィックスパック 60 をインストールする |
「その後、アプリサーバーを起動した後、構成ページに移動できます」 | 2. アプリケーション サーバーを起動する |
3. コントロール パネル > ナビゲーション> 3 ドット アイコン > 設定ページをクリックして、 設定ページ メニューに移動します。 |
完全な文ではなく、完全な思考で構いません。 理解できる必要があります:
特定の問題に直接役立つリンク:
- "ページを LAR ファイルとしてインポート/エクスポートする方法の詳細については、次の記事を参照してください: ページとコンテンツのインポート/エクスポート"
- 注: 記事のタイトルとハイパーリンクを書いた方がはるかに優れています。 生の URL をそのまま貼り付けないでください
スクリーンショットを使用:
*スクリーンショットやメディアに顧客固有の情報や内部ライフレイ情報が含まれていないことを確認してください
参照: HTML ヘルプ - 頻繁に使用:
- コード
- スクリーンショットの境界線
- ブルー ボックス コールアウト アラート
- テーブル
簡潔にしてください。 すべてに対処しようとしないでください。 1 つの記事 = 1 つのソリューション。
- 複数の問題がある場合は、複数の記事を作成します
追加情報
関連記事:
- "この親切な訪問の詳細については: OSGI and Modularity for Liferay Portal"
関連LPSチケット:
- 「これは、この問題に関連する機能リクエスト チケット LPS-64910 です。フォローして投票できます。」
注: 提供するすべてのリンクから言語コードを削除します。
- いいえ: https://help.liferay.com/hc/en-us/articles/360018174851-カレンダーの使い方-
- はい: https://help.liferay.com/hc/articles/360018174851-カレンダーの使い方の紹介-
記事の設定 (メタデータ)
これらは、KCS 記事に使用する必要がある記事設定です。
可視性の設定:
- 表示: KCS 0>
- CSE のトレーニング中にのみ使用
- 公開対象: 全員
- 公開(全文閲覧には認証が必要)
- 表示対象: 内部
- サードパーティ/範囲外の記事に使用されます。他のLiferay内部ユーザーのみが閲覧可能
* 詳細については、 KCS 記事のワークフロー を参照してください。
ラベル:
- ラベルは完全に一致する必要があります: (正確なラベルのリストについては、 HERE を参照してください)
- Liferayのバージョン
- コンポーネント
- こちらを参照してください: HC チケット ラベルからコンポーネント ラベルへのマップ