Joomla! Documentation™

O grupo de trabalho de documentação

O grupo de trabalho de documentação faz parte do departamento de produção. Ele é responsável por criar e manter todos os arquivos oficiais de documentação do Joomla! incluindo aquela para usuários finais, administradores e desenvolvedores de terceiros, bem como as telas de ajuda servidas nos backends dos sites Joomla!.

Equipe no portal de voluntários.

Subequipes de documentação

Equipe de tela de ajuda de documentação

A equipe de tela de ajuda de documentação é responsável pela manutenção e atualização das telas de ajuda para os lançamentos do Joomla!.

Equipe de tradução de documentação

A linguagem oficial da documentação é o inglês britânico. As traduções da documentação oficial para outras linguagens são de responsabilidade da equipe de tradução de documentação (JDT).

Grupo de trabalho de texto da interface do usuário en-GB

A equipe de texto da interface do usuário en-GB do Joomla! é responsável por estabelecer e manter as diretrizes oficiais de estilo para escrever strings en-GB, bem como garantir a consistência em todo o Joomla.

Wiki de documentação do Joomla!

A maior parte do esforço de documentação agora gira em torno desta wiki.

• Consulte o roteiro da wiki de documentação para obter uma visão geral completa das tarefas.
• Se você é novo no MediaWiki, então você deve consultar o guia do usuário para obter informações sobre como usar o software wiki.
• Existem algumas convenções para garantir que a wiki permaneça organizada.

• • Tente usar a convenção de nomeação de imagem.
  • Tente observar a convenção para rotular páginas com números de versão do Joomla!.

• Você pode querer dar uma olhada
  • as páginas solicitadas, mas ainda vazias
  • o Cookie jar: uma lista de páginas que foram categorizadas como tarefas pequenas e bem definidas que exigem um comprometimento mínimo para serem concluídas
  • Artigos que requerem revisão (também aguardando um editor de texto)
  • Artigos para os quais a informação é necessária: você pode ser aquele que conhece certos detalhes
  • Páginas de entrada: páginas que correspondem a palavras-chave importantes usadas por pessoas que usam mecanismos de pesquisa para encontrar documentação.
• Páginas que definem termos podem ser adicionadas ao glossário, mas não adicionando [[Category:Glossary]] à página. Por favor, consulte Talk:Glossary para mais informações.

Referências internas

• Lista de local wiki templates que podem ser usados em suas páginas da wiki. Os modelos reduzem a repetição e são a base da documentação modular.
• Lista de local wiki extensions que foram instaladas nesta wiki. Extensões fornecem funcionalidades adicionais à wiki, como syntax highlighting e link search.
• Lista de local interwiki links que estão disponíveis nesta wiki. Estes fornecem atalhos úteis para a criação de urls para outros sites, incluindo o fórum do Joomla!, as telas de ajuda e o rastreador de problemas; bem como links para a PHP documentation ou a Wikipédia.

Todos os sites de documentação

O grupo de trabalho de documentação atualmente mantém os seguintes sites:

api.joomla.org

Todo este site é gerado automaticamente pelo pacote phpDocumentor a partir de uma análise do código-fonte do Joomla! e fazendo uso de comentários especialmente formatados incorporados no próprio código-fonte. É uma ferramenta inestimável para todos os desenvolvedores do Joomla!.

docs.joomla.org

O conceito por trás do docs.joomla.org é que ele se tornará o recurso central para o desenvolvimento de documentação modular de fonte única dentro do projeto Joomla!. A idéia é que nós escrevemos coisas uma vez e depois as reutilizamos de uma maneira um tanto análoga ao desenvolvimento de software OOP moderno. Ao construir um banco de dados central de "pedaços" de documentos, obtemos o máximo benefício dos esforços de um número limitado de autores e produzimos documentos "ágeis" onde uma única alteração é rapidamente propagada para todos os documentos derivados afetados.

Os interessados nas técnicas encontrarão mais informações aqui.

Aqueles de vocês que não têm muita experiência em edição de imagens e podem querer melhorar a qualidade de suas capturas de tela devem ler o tutorial Fazendo capturas de tela – como melhorar.

Telas de ajuda do Joomla! são criadas nesta wiki e são mostradas no backend de qualquer site Joomla! daqui.

Outros recursos públicos

• Fórum de discussão público
• Lista de discussão do grupo de trabalho de documentação
• Lista de discussão da documentação para desenvolvedor
• O grupo de trabalho de documentação no portal de voluntários™ do Joomla!
• A equipe de tradução de documentação no portal de voluntários™ do Joomla!
• Tradutores de documentação
• Notas de configuração do MediaWiki
• Documentadores nesta wiki.