Documentation/pt-br

Visão Geral
Documentação técnica refere-se a qualquer documentação que contenha informações sobre um produto, processo ou tarefa técnica.

A documentação para projetos da Wikimedia está amplamente espalhada por diferentes wikis e sites. Esta página concentra-se na documentação técnica de e software relacionado.

Why contribute to technical documentation?
Technical documentation is an important part of Wikimedia technical projects. Quality documentation is especially important for open-source projects where folks from all over the world are working together. It provides history, context, accurate information, and repeatable steps that people can follow.

If you are interested in contributing to Wikimedia's technical projects, improving technical documentation can be a good starting place.

Where to find Wikimedia technical documentation
There are many Wikimedia technical projects, and sometimes it can be difficult to determine the best place to find or publish technical documentation. Following is a list of the main places to find Wikimedia technical documentation.


 * MediaWiki - MediaWiki software documentation and technical documentation for many other Wikimedia technology projects. This is the default space for publishing technical documents about Wikimedia technology.
 * Wikitech - Technical documentation for Wikimedia Foundation infrastructure and services. This includes production clusters, Wikimedia Cloud Services, Toolforge hosting, the Beta Cluster, and other data services.
 * Wikidata - Technical documentation related to the Wikidata project, particularly the Tools page.
 * PAWS - Documentation about PAWS, Wikimedia's hosted Jupyter notebooks instance. Notebooks are frequently used to create tutorials and documentation for Wikimedia technology.
 * Phabricator - Phabricator is a collaboration tool that is used by the Wikimedia technical community for task and bug management. You can find many issues and software projects documented here. Use best practices for software documentation when filing tasks and interacting in this space.

Estrutura de documentação

 * No :
 * Um Manual técnico para obter informações sobre o software MediaWiki.
 * Documentação baseada em projeto. Isso inclui guias do usuário, documentação da API, tutoriais, informações de desenvolvimento e materiais de referência relacionados a projetos específicos.
 * Páginas de ajuda contêm documentação específica do usuário final e  fornecem alguma documentação sob demanda.
 * Documentação da API gerada automaticamente:
 * Referência da API de ação
 * Referência da API REST
 * Documentação gerada a partir do código fonte do MediaWiki: doc.wikimedia.org.
 * Arquivos de texto no [$url diretorio /docs] da árvore de origem do MediaWiki possui informações relacionadas ao código.

Os recursos de suporte incluem blogs, páginas de discussão e fóruns de discussão.

Públicos-alvo da documentação
Os usuários principais da documentação do MediaWiki e o conjunto de páginas mais útil para cada grupo de usuários estão listados abaixo.

at and meta are concise forms of end-user documentation. Pages linked to and  contain sysadmin specific information. Manual:Contents serves as the reference guide. MediaWiki Administrator's Handbook and contain resources for administrators. serves as the reference guide. , and linked pages are a starting point for beginners. Experienced developers refer to. References include, , , , , etc., besides the software installation guidelines. Pages linked to. and for getting started followed by the project specific mediawiki pages.
 * Wiki users (end users of the MediaWiki software)
 * System administrators
 * Wiki administrators
 * Developers
 * Code developers and administrators
 * Add-ons developers
 * Designers
 * Translators and technical writers

For a more comprehensive exploration of the types of people who use Wikimedia technical documentation and their motivations, see Audiences for Wikimedia technical documentation.

Get started
New to technical documentation on Wikimedia projects? This page will help you get started right away.