FAQ とベストプラクティス
このセクションは、ナレッジ記事のベストプラクティスを案内し、よくある質問にお答えするために用意されています。
情報の対象読者が誰なのかを考えてください。情報の目的は何ですか？ 顧客が簡単にアクセスできますか？ どれくらいの頻度で更新されますか？
ベストプラクティスとして: ナレッジ記事はより簡潔で読みやすく、素早い回答や一般的な質問への解決策を目的とします。顧客が Issue や問題を解決するのに役立つナレッジ記事を作成しましょう。FAQ となるナレッジ記事を作成しましょう。よくある質問に対応／回答するもの。頻繁に更新されるナレッジ記事を作成しましょう。顧客が簡単にアクセスできる（検索可能な）ナレッジ記事を作成しましょう。
ベストプラクティス:
GitLab の用語を一貫して使う（命名規則）。
記事を作成する際は、適切な テンプレート と構造を使う
重複を避けるため、新しい記事を作成する前に既存の記事を検索する
記事は明確で焦点を絞ったものに保つ。
ローカリゼーションを意識して書く（シンプルに、明確に、顧客が理解／使える用語で書く）
バージョン管理する（適切な場所でラベルを使う）
他のリソースへリンクする
注意: 顧客向けの記事の場合、リンク先に顧客がアクセスできるかを必ず確認してください。アクセスできない場合は追加しないでください。
記事を適切に分類する。これは検索に役立ちます！
記事を最新に保つ（レビュー）。情報を補足できる記事を見つけたら、ぜひ更新してください！ 私たち全員がナレッジに貢献できます！
記事のタイトルは具体的にする（説明的になるようキーワードを使う）。タイトルは長くしないこと。
記事の概要を伝える要約を含める。
ユーザーがその記事が自分に当てはまるか理解できるよう、問題提起を含める。
明確な手順（箇条書き、画像、詳細）を含める。
ユーザーのコンテキストに基づいて記事を作成する。
読者向けに書く。読者がどう読むか（読者の言葉で）。
検索のためにキーワード（コンテンツタグ）を使う。検索語はナレッジ記事のコンテンツタグ、タイトル、説明から取得されます。
回避策とトラブルシューティングの手順を含める。
必要に応じてさらなるサポート情報を含める。
質問と回答
| 機能 | メモ |
|---|---|
| ナレッジについて助けが必要な場合は誰に連絡すればよいですか？ | Slack チャンネル #spt_Knowledge-base を使ってください |
| ナレッジの作成、変更、公開のためのトレーニングはありますか？ | はい！ 利用可能なトレーニングリソースのリストはナレッジベーストレーニングページにあります](./knowledge-base-training) |
| 自分が Support Engineer か Knowledge Champion かをどう確認できますか？ | ロールと権限のセクション で権限を確認してください。 |
| 作成したナレッジ記事の承認と公開は誰ができますか？ | Technical Reviewers が記事を承認して公開します。 |
bfd74782)