JDOC

JDOC:Como colaborar com a Documentação Joomla

This page is a translated version of the page JDOC:How to Contribute to Joomla! Documentation and the translation is 100% complete.

Other languages:
English • ‎español • ‎فارسی • ‎français • ‎हिन्दी • ‎Bahasa Indonesia • ‎Nederlands • ‎português • ‎português do Brasil • ‎Türkçe

A Documentação Joomla roda co o mesmo aplicativo usado pela Wikipedia. Seu crescimento e sucesso depende de pessoas como você. Obrigado por dar o primeiro passo para contribuir com o Projeto Joomla. Aqui você aprenderá como começar e várias formas de ajudar no trabalho da documentação.

Começando!

Essas são as coisas que precisam ser feitas primeiro.

Leia a Política Wiki

É necessário ler a Política do Wiki da Documentação Joomla antes de começar a editar.

Criar uma Conta de Usuário

Para editar o Wiki da Documentação Joomla, você precisará de uma conta de usuário. Você poderá se cadastrar aqui. Depois disso, confirme seu endereço de e-mail, o que lhe dará permissão para editar todas as páginas, exceto algumas que são bloqueadas por precaução.

Criar uma página de usuário

Depos de ter criado sua conta, confirmado seu e-mail e entrado, você deverá criar sua página de usuário. Veja essa dica:

Entre na Lista de E-mails da Documentação

É bom que você participe da Lista da Documentação. Não é obrigatório, mas lá discute-se assuntos importantes e relevantes para a documentação.

O que devo fazer primeiro?

Existem várias área da documentaçao que sempre precisam de atenção. Comece escolhendo aquela em que você se sente mais a vontade para trabalhar ou você pode escolher várias para trabalhar ao mesmo tempo. Assim que tiver sua conta wiki, você será livre para trabalhar em qualquer aspecto da documentação. Mesmo contribuições mais simples como correção de palavras e gramática são de uma enorme ajuda!

  1. Ajudar com conteúdo da documentação.
  2. Tarefas de manutenção.
  3. Participe ou inicie um projeto de documentação.
  4. Ajudar com as telas de Ajuda.

Ajudar com conteúdo da documentação

  1. Edição, recriação e reorganização de páginas. Confira as Páginas com Demandas para saber as áreas que mais precisam de ajuda a cada momento. Elas são chamadas 'Páginas com Demandas' pois precisam de pequenos ajustes para serem finalizadas. Algumas precisam somente de revisão ou inserção de imagens. Outras necessitam de melhoras ou aumento de conteúdo. Pegue algumas para dar toda sua atenção. Essa é uma ajuda enorme para os usuários de Joomla! que dependem da documentação.
  2. Divirta-se buscando por artigos que são repetidos, de versão antigas (1.0 ou 1.5) ou precisam ser divididos por conta de informações específicas de cada versão. Sinta-se a vontade para fazer uso dos temas {{delete}}, {{merge}} ou {{JSplit}} nos artigos. Clique no template anterior para ver como o usar e aplicar nos artigos que você acredita necessitarem deles. Coloque-os no topo de uma página e assim ela estará marcada.
  3. Criar uma nova página ou tutorial. Se você quiser criar uma página nova, faça uma pesquisa profunda primeiro. Evite criar um novo artigo se já existe outro. Use o recurso de busca da Wiki de Documentos para ver se o tópico já está em um artigo. Duplicidades serão combinadas e/ou apagadas. Não tenha medo de modificar, reformatar ou melhorar o trabalho de outra pessoa dentro da Wiki de Documentos Joomla! Essa é uma wiki colaborativa e tenha certeza de que está seguindo nossas políticas e orientações.
    1. Usando wikilinks. É muito fácil ligar páginas usando uma sintaxe padrão. Se você criar um link para um artigo que não existe ainda, o link será colorido de vermelho. Clicar em um link vermelho levará você para a página de edição do novo artigo. Basta digitar o texto, clique em salvar e a nova página será criada. Uma vez que a página foi criada, o link vai mudar de vermelho para azul indicando que o artigo agora existe.
    2. Usando a URL. Para usar quando você deseja criar uma página a partir do zero. Você pode usar a URL da wiki para criar uma nova página. A URL para um artigo do wiki é geralmente algo assim: https://docs.joomla.org/SEUTITULO. Se você substituir SEUTITULO com o nome da página que você quer criar, você será levado para uma página em branco que indica que nenhum artigo com esse nome existe ainda. Clicar no link Criar esta página irá levá-lo para a página de edição desse artigo, onde você pode criar a nova página digitando seu texto e clicando em Enviar.
  4. Ajude a atualizar imagens nos artigos. Verifique a categoria Necessita atualização das imagens para uma lista de páginas que precisam ter suas imagens atualizadas. Nossas orientações para ajudá-lo podem ser encontradas no artigo Diretrizes para nomear imagens.


Manutenção do Wiki

Manter um wiki organizado é um grande trabalho sem fim feito pelos administradores, editores e usuários. Sempre há tarefas necessitando de atenção, como:Categorização, verificar pendências das páginas, que estão em elaboração ou marcar páginas para eliminação, unificação or separação. Para todas as tarefas de manutenção e idéias de como você pode ajudar, por favor visite nossa página de Documentação para Manutenção.

Projetos de Documentação

Telas de Ajuda

Muitos não sabem, mas todas as páginas das Telas de Ajuda são criadas e apresentadas nas instalações de Joomla! pelo mundo a partir desse wiki! São essenciais para quem está iniciando e mesmo aqueles com um bom conhecimento de Joomla!

As Telas de Ajuda do Joomla! 3.x estão prontas mas as do Joomla! 3.7 ainda estão sendo desenvolvidas. As contribuições que você puder fazer beneficiarão muitos usuários espalhados pelo mundo. Você pode encontrar a matriz das Telas de Ajuda 3.x aqui. Algumas precisam ser revisadas e marcadas como finalizadas, outras precisam ser iniciadas, finalizadas, ter imagens adicionadas (largura máxima 800px), etc.
  • As Telas de Ajuda do Joomla! 4.x precisam ser completamente criadas. Qualquer contribuição que você der a elas será apreciado por muitos usuários em todo o mundo e estamos procurando voluntários para ajudar com esta importante tarefa. Uma matriz precisa ser posta em prática, bem como um plano de ação.


Detalhes a serem levados em conta

Aqui estão alguns detalhes a serem levados em conta como contribuinte da Documentação Joomla!

  • Não tenha medo de quebrar uma página. Se você fizer algo errado, desfaça sua edição. Clique no link Histórico para ver os links de desfazer e reverter.
  • Escreva os artigos lembrando que estes serão traduzidos para outras línguas. Usar gíria ou termos regionais pode dificultar a tradução para outros idiomas e a compreensão do texto.
  • Não tenha medo de baixar e ler o Guia de Estilos Editoriais (PDF) comum a toda Documentação Joomla! Lá encontram-se dicas valiosas para escrever os documentos.
  • Palavras a observar quando escrever, leia o guia completo … ou use os navegadores Google Chrome ou Mozilla Firefox para uma resposta rápida. Ambos possuem corretores ortográficos que marcam as palavras escritas de forma incorreta.
  • Lembre-se de o tema {{inuse}} ao artigo no qual vai se trabalhar por um longo período. Isso ajuda a evitar conflitos de edição.

Socorro, eu não conheço a marcação Wiki!

Se o uso de Wikis e sua marcação simples para criação de páginas são novidades para você, então use a ajuda a seguir.

  • O Novo WikiEditor contém botões e links rápidos para facilitar a construção de páginas. Clique na palavra 'Avançado' para ver o menu com mais botões e links de formatação rápida.
  • Use a cola Wiki do JDOC para aprender os comandos de sintáxe básicos. O editor também possui um menu com as marcações mais usadas. Clique em 'Ajuda' para ver exibir o menu.
  • Ainda com receios? Confira essas ferramentas para ajudar na criação de páginas wiki otimizadas.
  • Microsoft Word Add-on for Wiki Markup, salva documentos do Word com marcação Wiki.
  • OpenOffice.org versões 2.4 e posterior tem um filtro de exportação para MediaWiki nativo. Basta abrir um documento no Writer e clicar em Arquivo > Exportar. Depois, mude o formato do arquivo para MediaWiki.
  • Aqui está uma lista de ferramentas disponíveis para converter outros formatos para a marcação Wiki como, por exemplo, HTML, Excel, CSV. Algumas ferramentas são conversores online, onde se tem que cortar e colar HTML para obter uma conversão em marcação wiki.
  • Obtenha ajuda no Glip (nós temos 2 grupos lá: um para o Grupo de Tradução JDocs e um para o Grupo de Trabalho JDocs).
  • Poste sua pergunta na talk page de um administrador ou editor.
Advertisement