ドキュメントのガイドライン

このページでは、ドキュメントを作成または確認するか、既存のドキュメントを翻訳してGodot Engineに貢献する場合に従うべき規則について説明します。また、`godot-docs GitHubリポジトリ <https://github.com/godotengine/godot-docs>`_のREADMEと、従うべき手順とドキュメントチームに連絡する方法については `ドキュメントフロントページ <https://docs.godotengine.org>`_をご覧ください。

貢献する方法

ドキュメントページの作成または変更は、主にgodot-docs GitHub リポジトリを介して行われます。HTML(またはPDFおよびEPUB)ドキュメントは、そのリポジトリの.rst ファイル (reStructuredTextマークアップ言語) から生成されます。プルリクエストでこれらのページを変更し、マージすると、オンラインドキュメントの再構築がトリガーされます。

参考

Gitの使用状況とプル要求ワークフローの詳細については、プルリクエスト・ワークフローページを参照してください。メインの godotengine/godot リポジトリに関する記述のほとんどは、ドキュメントリポジトリにも有効です。

README.mdファイルには、あなたが開始するために必要なすべての情報が含まれていますので、それを読んでください。特に、reStructuredTextマークアップ言語に関する参考資料へのヒントとコツとリンクが含まれています。

警告

APIリファレンスを編集する場合は、godot-docsリポジトリで行ってはならないことに注意してください。 代わりに、Godotのメインリポジトリの doc/classes/* XMLファイルを編集する必要があります。 これらのファイルは、後でエディタ内のドキュメントとオンラインドキュメントのAPIリファレンスを生成するために使用されます。 詳細はこちら:クラスリファレンスへの貢献

優れたドキュメントとは何ですか?

ドキュメンテーションは、整形式の文とさまざまなレベルのセクションとサブセクションを使用して、わかりやすい英語で適切に作成する必要があります。それは明確で客観的でなければなりません。ドキュメント作成ガイドライン もご覧ください。

チュートリアルページを他のドキュメントページと区別します:

  • チュートリアル:学習目的で特定の目標を達成するためにエディタまたはスクリプトで1つ以上の概念を使用する方法を説明することを目的としたページ(例:「シンプルな2D卓球ゲームを作る」、「オブジェクトに力を適用する」など)。
  • ドキュメント:可能であれば、一度に1つだけの概念を正確に記述するページ (Spriteクラスのメソッドの一覧やGodotの入力管理の概要など)。

次のルール(およびレポのルール)を尊重する限り、希望する種類のドキュメントを自由に作成できます。

タイトル

常にタイトルと Sphinx参照名でページを開始します:

.. _doc_insert_your_title_here:

Insert your title here
======================

このリファレンスでは :ref: 形式を使用してこのページにリンクすることができます。例えば :ref:`doc_insert_your_title_here` とすると、上記の例のページにリンクします(参照の先頭にアンダースコアがないことに注意してください)。

また、アメリカのキャメルケースのタイトルは避けてください。タイトルの最初の単語は大文字で始める必要があり、その後に続く単語はすべて大文字で始めるべきではありません。たとえば、次のようになります:

  • Insert your title here (注:これは英文専用の留意項目です)

これは悪い例です:

  • Insert Your Title Here (注:これは英文専用の留意項目です)

プロジェクト名、ユーザー名、およびノードクラス名だけは先頭を大文字にしてください。

既存のページの翻訳

`Hosted Weblate <https://hosted.weblate.org/engage/godot-engine/>`_でGodotの公式ドキュメントを翻訳することができます。

Translation state

公式の `Godot I18Nリポジトリ<https://github.com/godotengine/godot-docs-l10n>`_もあります。データが最後に同期された日時を確認できます。

ライセンス

このコンテンツは、"Juan Linietsky"、 "Ariel Manzur " そして "Godot Engine community" によって、クリエイティブ・コモンズ-表示 3.0( CC-BY 3.0)ライセンスの下、管理されております。

GitHubリポジトリのドキュメントに投稿することで、変更がこのライセンスの下で配布されることに同意します。