Ferramentas de Utilizador

Ferramentas de Site


wiki:regras_e_guia_de_estilo

Conceber um bom artigo é uma actividade que pode trazer grande satisfação ao(s) autor(es). Todavia, para que um artigo possa atingir um nível elevado é necessário algum trabalho.

O objectivo desta página é criar algumas guidelines para criar artigos de qualidade para a Wiki.

Regras e guia de estilo

Pesquisar

  1. Procurar artigos idênticos na Wiki P@P, caso existam porque não completá-los?
  2. Antes de criar uma página, procurar informação na Wikipédia, w3schools, ou outro site de grande popularidade potencial de conter o mesmo tipo de conteúdo. Se o conteúdo a criar coincidir, em geral, com uma entrada dos sites referidos, então não vale a pena mantê-lo aqui.

Escrita

  1. O artigo deve começar com uma introdução sobre o artigo de forma a que o leitor consiga facilmente entender sobre o que o artigo trata e identificar se é o que procura ou não.
  2. Há que ter em atenção que não se pode simplesmente copiar o conteúdo de outras fontes. É necessário ter em atenção os direitos de autor.
  3. Salvo situações como artigos a publicar na revista programar, o texto deve ser sintetizado e ilustrado sempre que possível com exemplos práticos de código. Fragmentos de texto de grande dimensão não são indicados para a grande maioria das situações.
  4. Caso ainda não esteja familiriarizado com o sistema de formatação da DokuWiki, deve consultar o Guia de Estilo e Formatação existente.
  5. Código demasiado extenso pode tambem tornar-se pouco informativo. Deve ter-se o cuidado de o documentar e explicar bem.
  6. Não incluir conjugações de verbos na primeira pessoa do singular, nem referencias a opiniões ou experiências pessoais.
  7. Sempre que possível, as páginas devem ser escritas de forma a ser usadas como referência. Isto significa que se deve possibilitar ao leitor compreender cada parte de uma página sem ter que a sequencialmente e/ou na íntegra.
  8. O código fonte deve ser afixado em formato de texto e com a tag apropriada, com colorização de sintaxe.
  9. Entradas com definições de conceitos para leigos só devem ser submetidas se se tratar de um assunto que ainda careça de documentação bem difundida na web em geral.
  10. Links entre páginas deste wiki não devem ser usados com tanta frequência como na Wikipédia.
  11. Se o conteúdo a afixar for um code snippet, este deve ser criado na pasta de snippets da linguagem correspondente.

Edição

  1. Sempre que achar que pode completar / corrigir um artigo existente na Wiki P@P sinta-se livre de o fazer de forma a contribuir para melhorar o artigo e o seu conteúdo.
  2. Tenha sempre em mente as 'regras' que são aplicadas à criação de novos artigos.
wiki/regras_e_guia_de_estilo.txt · Esta página foi modificada pela última vez em: 2016/06/25 13:51 por Rui Carlos