トラブルシューティングのトピックタイプ
トラブルシューティングのトピックは、ページの最後のトピックにする必要があります。
ページに5つ以上のトラブルシューティングトピックがある場合、そのコンテンツはトラブルシューティング情報のみを扱う別のページに置いてください。ページ名はTroubleshooting <feature> とし、左ナビではTroubleshooting のみを使用します。
どのようなトラブルシューティング情報を含めるべきか
トラブルシューティング情報には以下が含まれます：
- 危険と思われる問題解決情報。
- 稀なケースに関する情報。ユーザーが遭遇する可能性がどんなに低い状況であっても、すべてのトラブルシューティング情報が含まれています。
このような内容は他の人の役に立つ可能性があり、その利点はリスクを上回ります。このルールに例外があると思われる場合は、テクニカルライティングチームまでご連絡ください。
GitLabサポートは独自のトラブルシューティングコンテンツをメンテナーしています。
トラブルシューティングのトピックタイプ
トラブルシューティングには、入門、タスク、リファレンスの3つのタイプがあります。
入門トピック
このトピックは、ページのトラブルシューティングのセクションを紹介します。例えば
## Troubleshooting
When working with <x feature>, you might encounter the following issues.
トラブルシューティング・タスク
タイトルは標準的なタスクに似ていなければなりません。例えば、”デバッグツールの実行 “や “構文の検証 “などです。
トラブルシューティングリファレンス
このトピックにはエラーメッセージが含まれます。例えば
### The error message or a description of it
You might get an error that states <error message>.
This issue occurs when...
The workaround is...
複数の原因や回避策が存在する場合は、表形式にすることを検討してください。正確なエラーメッセージを使用する場合は、バックティックで囲み、コードとして表示されるようにします。
トラブルシューティングのトピックタイトル
トラブルシューティングのリファレンストピックのタイトル：
- 少なくともエラーメッセージの一部を含めることを検討してください。
- 文字数は70文字以下にしてください。
- タイトルにリンクを使用しないでください。
タイトルに完全なエラーを記載しない場合は、本文に記載してください。
Railsコンソール書き込み関数
トラブルシューティングの提案にGitLabインスタンスのデータを変更する関数が含まれている場合は、以下の警告を追加してください：
WARNING:
Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore.