MoodleDocs:Guidelines for contributors

A sua colaboração é bem vinda na documentação do Moodle (Docs). Quando encontrar algo que possa ser melhorado, tanto no conteúdo como na gramática ou no formato, ajude a comunidade melhorando o texto. Esta página lhe dará algumas idéias e diretrizes.

Introdução

Você é bem vindo a contribuir com o Moodle Docs. Encontre algo que possa ser melhorado, tanto em conteúdo, gramática ou formatação, e corrija!
Se você ainda não o fez, por favor autentique-se.
Por favor, note que todas as contribuições publicadas aqui estão sob a GNU General Public License.
A partir do Moodle 1.6, toda página do moodle tem uma página correspondente no Moodle Docs. Você pode ver isso em moodle.org e, da perspectiva de um administrador, no Moodle demo site.
Por favor, perceba que os Arquivos de ajuda do Moodle permanecerão em cada pacote de idioma, logo seus textos não precisam ser incluídos nesta documentação, no entanto não há problema em um pouco de informação duplicada.
Você é encorajado a ilustrar a documentação com screenshots. Por favor, veja o guia de estilo para mais informações.
Existem tags que você pode incluir para pedir a outros colaboradores alguma ajuda na edição. Isto inclui pedidos de exclusão, atualização e notação de rascunho

Criando novas páginas

Você é bem vindo a criar novas páginas para documentação adicional. Simplesmente digite o nome da sua nova página entre duplos colchetes [[Nome da nova página]] em uma página existente e siga o link par começar a editar a nova página. Alternativamente, você pode digitar na barra de endereços do seu navegador: https://docs.moodle.org/pt_br/Nome_da_nova_pagina (substitua os espaços no nome da nova página por "underscores", "_" )
Por favor, escolha um nome curto e use apenas a primeira letra maiúscula (com pouca exceções, como a palavra Moodle).
Nova documentação de desenvolvedor deve ser adicionado ao Development namespace digitando Development: antes do nome da página, por exemplo [[Development:Nova página]]
Por favor, siga o guia de estilo. Categorizar as novas páginas pode deixar mais fácil para os usuários achá-las, mas o mais importante é colocar bom conteúdo na página.
Títulos de páginas podem ser alterados no futuro, redirecionando/movendo páginas, como parte de reestruturação da documentação

Tipos de páginas

Como o Moodle Docs cresceu com o passar do tempo, diversos tipos de estilos para páginas com suas próprias orientações informais emergiram. Conforme você olhar para as páginas você provavelmente reconhecerá algumas destas. Entretanto, a regra básica é que se não há conteúdo na página, não há nada para achar e certamente nada para a comunidade editar e considerar. Assim, por favor, sinta-se livre para adicionar conteúdo e não se preocupe com os refinamentos abaixo.

Páginas gerais - as mais comuns e variadas. O Guia de estilos dá uma boa idéia do potencial. Esta página mesmo é um exemplo de uma página geral.

Páginas de introdução. Estas servem quase como uma tabela do conteúdo sobre um assunto, com links para páginas com informação mais detalhada. Diversas técnicas são utilizadas. Algumas vezes, links são colocados em uma lista de marcadores. Ou pequenas sentenças podem ser utilizadas para dar contexto aos links para páginas. Você pode notar que algumas das principais páginas de introdução são protedigas.

Páginas de FAQ. FAQs são similares a páginas de introdução. Neste tipo de página, cada título tem algo sobre uma pergunta que é frequentemente respondida, a resposta tipicamente é curta. A resposta fornece links para páginas ou links para uma sessão específica que deve expandir a resposta para a questão. É legal incluir um item que tenha particularmente frustrado você, junto com a descrição da solução. Como qualquer coisa no Moodle Docs, isto pode ser editado. Frequentemente os leitores encontram estas páginas em links nos fórums do moodle.org. O FAQ do módulo Lição (em inglês) é um exemplo.

Páginas de código contribuído. Estas tendem a ter links para a base de downloads do moodle.org e para o fórum que discute questões relacionadas. É claro que existirá uma breve descrição dos propósitos do código, uma lista de funcionalidades, talvez algumas dicas sobre como instalar e configurações úteis. Um exemplo é o módulo Book.

Links entre idiomas

Você é bem vindo a incluir links inter-idiomas entre páginas de diferentes idiomas. Simplesmente digite, por exemplo [[es:Título da página correspondente em Espanhol]] no MoodleDocs em português, ou [[pt_br:Título da página correspondente em Português]] no MoodleDocs em Espanhol, no fim da página, abaixo do link da categoria. Links inter-idiomas aparecerão automaticamente no bloco "Outras línguas". Com exceção do Inglês, apenas idiomas relacionados são interligados. (Se você acredita que um idioma relacionado não está incluído, contate o administrador do Docs.)

Indicadores de versões do Moodle

Quando adicionando documentação sobre uma nova funcionalidde, por favor inclua o template da versão do Moodle, digitando, por exemplo {{Moodle 1.9}}.
Além de realçar diferenças nas versões do Moodle, os templates de versão do Moodle automaticamente categorizam artigos em categorias de versão, por exemplo Category:Moodle 1.9.
Templates para versões do Moodle que não estão mais disponíveis em Moodle downloads podem ser removidos e substituídos por texto simples, por exemplo "A partir do Moodle 1.5, ...".

Comentários de páginas

Para comentário sobre uma página em particular, e/ou pequenas discussões, use a respectiva página de discussão (clique na aba discussão). Por favor, autentique-se e coloque uma data na sua contribuiçção na página de discussão digitando quatro tios ~~~~. Existe também um ícone para assinatura na barra de ferramentas do campo de edição Imagem:Signature Icon.png
Para discussões mais longas sobre a documentação, utilize o fórum de Documentação.
Se você encontrar um comentário não assinado, você pode utilizar o Template:Unsigned, como {{Unsigned|Username}} que será mostrado um (The preceding comment was added by Username)

Proteção de páginas

Algumas páginas são protegidas de edição. Para estas páginas, tente contribuir através da respectiva página de discussão.
- Dica: Copie o conteúdo de uma página protegida, cole em uma nova página, então edite a nova página. Na aba "discussão" da nova página, dê as razões para a edição. Então, na aba "discussão" da página protegida, chame atenção para a nova página com o link e um resumo dos seus motivos para alteração.
Para uma lista das páginas protegidas veja Category:Protected pages.

Veja também

Documentation