Writing documentation

We always need help to improve the documentation, be it the class reference or the manual. Below, you can find our content and writing guidelines and concrete guides to make changes to the documentation.

Be sure to also check the workflow guidelines, especially if you're new to using Git or GitHub.

ガイドライン

Here are the principles and guidelines we strive to follow to write accessible documentation.

• コンテンツガイドライン
• ドキュメント作成ガイドライン
• Creating documentation images and videos
• Documentation contribution checklist

Writing the manual

These articles explain how to contribute to this very documentation, and how to build the online version locally for testing.

• ドキュメントへの貢献
• Building the manual with Sphinx

Class reference guides

以下のページではクラスリファレンスに焦点を当てています。

As the reference is included in the Godot editor, its source files are part of the godot repository. We use XML files to write it, so the process to contribute to the class reference differs from writing the online manual.

• Contributing to the class reference
• Class reference primer

ドキュメントの翻訳

コミュニティは常にGodotとそのドキュメントがより多くの人に利用されるように努めています。ドキュメントを翻訳することはあなたが参加可能な巨大かつ継続的な取り組みです。

• エディタとドキュメントの翻訳