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

QGISドキュメントは https://docs.qgis.org にあります。執筆作業が進行している間、サポートされているすべてのバージョン (テスト版、長期リリース (LTR)、LTRになる予定のもの)のビルドが毎日自動的に実行されます(正確な時刻はページの一番下を参照してください)。

QGIS Documentationのソースファイルは、https://github.com/qgis/QGIS-Documentation で入手できます。これらは主にreStructuredText (reST)フォーマットの構文を使って書かれており、Sphinxツールセットのいくつかのスクリプトと結合して、HTML出力の後処理を行います。これらのツールに関する一般的な情報は、https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html または https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html を参照してください。

以下の章では次のようなことを学ぶことができます。

  • how to manage the documentation source files using git system and the GitHub platform on which they are stored

  • ルールに準拠した方法でテキストを変更し、スクリーンショットを提供する方法

  • あなたの行った変更を確実に公式ドキュメントに取り込み共有する方法

QGISプロジェクトに貢献する方法に関する一般的な情報を探している場合は、 QGISコミュニティに参加する にヘルプを見つけることができます。