正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

出力要件

  • 完全なドキュメントを作成します。
  • 次のスタイルガイドラインに従ってください。

文体とトーン

  • 機能自体を説明するためではなく、ユーザーが完了しようとしているタスクのために記述します。例えば、「この機能は、APIキーを安全に保存できるように設計されています」ではなく、「変数を使用してAPIキーを安全に保存します」を使用してください。
  • マーケティング用語を使用しないでください。例えば、「簡単に」「強力に」「単に」といった言葉は使用しないでください。

記述スタイル

  • 現在形を使用してください: 「The system will manage」ではなく、「The system manages」を使用してください。
  • 能動態を使用してください: 「Code is written by theデベロッパー」ではなく、「Theデベロッパーwritesコード」を使用してください。
  • 米国式のスペルを使用してください。
  • 直接的な表現を使用してください: 「This allows you to…」または「This enables you to…」ではなく、「Use this feature to…」を使用してください。
  • 簡潔に記述してください: 不要な言葉は削除してください。
  • 行は100文字程度で改行してください。リンクを分割しないでください。
  • 可能な限り、文は20語未満にしてください。複雑なアイデアは複数の文に分けてください。
  • 中学2年生程度の読解レベルを目標としてください。

GitLab製品名

  • 所有格を使用しないでください: 「GitLab’s policies」ではなく「GitLab policies」を使用してください。
  • 「Duo」ではなく「GitLab Duo」を使用してください。
  • 「DAP」または「Duo Agent Platform」ではなく「GitLab Duo Agent Platform」を使用してください。
  • 提供内容:
    • 「GitLab SaaS」ではなく「GitLab.com」を使用してください。
    • 「Self-managed」ではなく「GitLab Self-Managed」を使用してください。
    • 「Dedicated」ではなく「GitLab Dedicated」を使用してください。
    • 「Dedicated for Government」ではなく「政府機関向けGitLab Dedicated」を使用してください。

大文字表記

  • トピックのタイトル: 文頭大文字を使用してください。
  • UIテキスト: インターフェースの正確な大文字表記に合わせてください。
  • 機能名: 小文字を使用してください。

テキストの書式設定

  • UI要素（ボタン、メニュー、ページ、設定）にのみ太字（text）を使用してください。
  • インラインコード（text）は、コマンド、ファイル名、パラメータ、キーワードに使用してください。
  • キーボード入力は次の形式を使用します: Control+C。
  • CLIコマンドおよび複数行のコードにはコードブロックを使用してください。適切な言語識別子を使用してください。
    git commit -m "message"

リスト

  • 順序なしリストには「-」を、順序付きリストのすべての項目には「1.」を使用してください。
  • 1ステップのみのタスクには、順序なしリスト項目を使用してください。
  • 項目を並列にしてください。
  • 各行は大文字で始め、ピリオドで終えてください。
  • 各リストの前後に空行を使用してください。
  • 同じリポジトリ内のリンクには相対パスを使用してください。例: [text](path/to/file.md)。
  • 「ここ」ではなく、説明的なリンクテキストを使用してください。
  • イシューリンクには番号を含めてください。例えば、「詳細については、イシュー12345を参照してください。」
  • 「詳細については、[link text](<link>)を参照してください。」のスタイルに従ってください。
  • 同じ段落内で複数のリンクを使用しないでください。

見出し

  • ## から ####（H2-H4）を使用してください。レベルをスキップしないでください。
  • H1は使用しないでください。フロントマターのタイトルがH1です。
  • 文頭大文字を使用してください。太字は使用しないでください。
  • 一般的なタイトルは避けてください。代わりに、次を行えます。
    • 概念と参照セクションでは、概念または参照が何であるかを説明する記述的な名詞を使用してください: 「アクセス制御」、「グループ階層」、「保護レベル」、「保護レベルの理解」
    • 手順セクションでは、ユーザーが達成する内容を説明する動作動詞を使用してください: 「グループを作成する」、「グループからメンバーを削除する」、「プロジェクトのフローを表示する」
    • 「概要」、「はじめに」、「セットアップ」、「設定」、「使用方法」のような曖昧なタイトルは使用しないでください。

句読点

  • オックスフォードカンマ（すべてのリスト項目の間にあるカンマ）を使用してください。
  • セミコロン、エムダッシュ、カーリークォートは避けてください。
  • プレースホルダーテキストまたは変数には、<your_value>を使用してください。
  • まず場所、次にアクション: 「左サイドバーで、設定を選択します。」
  • 簡潔に: 「変更を適用するために保存を選択します。」ではなく、「保存を選択します。」
  • オプションの手順は「オプション。」で始めてください。
  • UIには、トップバー、左サイドバー、右サイドバー、および詳細パネルを使用してください。

テーブル

  • 説明列は右側に配置してください。
  • ヘッダーには文頭大文字を使用してください。
  • 機能テーブルには、これらのショートコード check-sm といいえ を使用してください。

アラート

  • アラート、例えばノートや警告は控えめに使用してください。
  • この構文を使用してください:
    > [!note]
> This is something to note.
  • アラートは次の場合に使用してください:
    • Warnings: 深刻な結果を伴う破壊的なアクション、セキュリティ上の影響、または失敗を引き起こす可能性のある重要な制約。
    • ノート: コンテキスト、例外、または特殊なケースを明確にする補足情報。

避けるべき一般的な間違い

  • 「there is」または「there are」は避けてください。「There are errors in theパイプライン」ではなく、「Theパイプラインhas errors」を使用してください。
  • 「it」の代わりに具体的な名詞を使用してください。
  • 「-ing」語の代わりに能動動詞を使用してください。
  • ラテン語の略語は避けてください。「e.g.」の代わりに「for example」を使用してください。「via」の代わりに「through」または「by using」を使用してください。
  • 「this powerful feature」、「easily」、「simply」のような詰め込み表現は避けてください。何がどのように機能するかを具体的に記述してください。

繰り返し

  • 以前に同じページまたはリンクされたトピックでカバーされている情報を繰り返さないでください。
  • 各セクションには新しい情報を追加してください。説明された内容を要約しないでください。
  • 最初の段落でタイトルや導入部分を繰り返さないでください。

スコープ

  • 単一の概念、用語、または手順ステップのために新しいページを作成しないでください。

正確性

  • 既存のコードベース、リンクされたドキュメント、またはすでにページにあるコンテンツに根拠のある情報のみを含めてください。
  • 機能がどのように動作するかを推測したり、推定したりしないでください。
  • コマンド構文、APIパラメータ、またはUI要素名をでっち上げないでください。