Importante

Translation is a community effort you can join. This page is currently translated at 66.67%.

Diretrizes de documentação

QGIS Documentation is available at https://docs.qgis.org. As the writing process is going on, a build is automatically run every day (see bottom of the page for exact time) for all supported versions (testing, Long Term Release (LTR) and next-to-be LTR).

Os arquivos de origem da documetação do QGIS estão disponíveis em https://github.com/qgis/QGIS-Documentation. Eles são escritos principalmente no formato reStructuredText (reST), juntamente com alguns scripts do conjunto de ferramentas Sphinx para pós-processar a saída HTML. Para obter informações gerais sobre essas ferramentas, consulte https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html ou https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html.

The following chapters will guide you through learning:

  • como gerenciar os arquivos de origem da documentação usando o sistema git e a plataforma GitHub em que estão armazenados

  • how to modify the texts, provide screenshots… in a compliant way

  • como compartilhar e garantir que suas modificações sejam enviadas às documentações oficiais.

Se você estiver procurando informações gerais sobre como contribuir para o projeto QGIS, poderá encontrar ajuda em Participe da comunidade QGIS.