Documentação

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 MediaWiki e software relacionado.

Páginas de documentação

• Guia de estilo de documentação do MediaWiki
• Predefinições para formatar texto
• Recursos para documentaristas técnicos
• Diretrizes para tarefas de documentação técnica
• Diferentes gêneros de redação técnica
• Um guia para novos escritores técnicos

Estrutura de documentação

• No MediaWiki.org :
  • 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 Special pages 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 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.

Algumas documentos ainda está para ser migrado de meta.wikimedia.org. Consulte MetaProject transferir conteúdo para o MediaWiki.org

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.

• Wiki users (end users of the MediaWiki software)
  Ajuda:Conteúdo at mediawiki.org and meta are concise forms of end-user documentation.
• System administrators
  Pages linked to Category:MediaWiki for site admins and Administradores de sistema contain sysadmin specific information. Manual:Contents serves as the reference guide.
• Wiki administrators
  MediaWiki Administrator's Handbook and Manual:Administradore contain resources for administrators. Manual:Conteúdos serves as the reference guide.
• Developers
  • Code developers and administrators
    Novos desenvolvedores , Manual:Conteúdos and linked pages are a starting point for beginners. Experienced developers refer to Central do desenvolvedor .
  • Add-ons developers
    References include Central do desenvolvedor , Manual:Extensões , Categoria:Extensões , Cozinha de gadgets , Manual:Bots , etc., besides the software installation guidelines.
  • Designers
    Pages linked to Design .
  • Translators and technical writers
    Central do tradutor and Ajuda:Conteúdo for getting started followed by the project specific mediawiki pages.

Hackathons e divulgação

• Technical Documentation Tasks for Hack-a-thons
• Season of Docs