DokuWiki

It's better when it's simple

Ferramentas do usuário

Ferramentas do site


Barra lateral

Esta tradução é mais antiga que a página original e pode estar desatualizada. Veja o que foi mudado.
Traduções desta página?:

Learn about DokuWiki

Advanced Use

Corporate Use

Our Community


Follow us on Facebook, Twitter and other social networks.

Our Privacy Policy

pt-br:tips:good_style

Dicas de bom estilo

Estas são algumas dicas como escrever uma boa página Wiki.

Estrutura da página

  • Comece a página com um cabeçalho de primeiro nível com um título significativo.
  • Idente os níveis de cabeçalhos na ordem correcta, secções de segundo nível devem começar com um cabeçalho de segundo nível.
  • Divida o texto em parágrafos deixando uma linha vazia entre eles. Um parágrafo em média não deve ter mais de 10-20 linhas.
  • Se o texto tem alguns /3-5) parágrafos, considere dividi-lo em secções adicionando cabeçalhos de segundo a quinto níveis.
  • Quando o texto se alonga por 2-3 telas, coloque um curto resumo do conteúdo da página depois do primeiro cabeçalho. Quando a página fica significamente longa considere dividi-la em páginas múltiplas.
  • Se faz muitas ligações a outras páginas Wiki ou recursos externos, adicione uma secção com referências futuras.
  • Se a maioria das páginas dum espaço partilham uma estrutura comum adicione um modelo para que cada página nova possa começar com o mesmo esquema.
  • Tente evitar estruturas de espaços supercomplicada. Tente usar nomes curtos e fáceis de lembrar para os espaços.

Formatação de Texto

  • Realce palavras ou pequenas passagens do texto com bold ou italics. Escolha um deles e use-o coerentemente em todo o texto.
  • Escolha um estilo para representar imagens da tela e texto na tela como botões ou etiquetas e use-o consistentemente. Será uma boa ideia adicionar uma página com as convenções de estilo que escolheu.
  • Use “unordered lists” para afirmações que são independentes entre si. Se pretende desenvolver uma linha de pensamento, escreva uma sequência contínua de frases.
  • Use “footnotes” com moderação e apenas para notas adicionais muito curtas. Se tem muito a dizer num tópico específico, coloque-o numa página nova. Se pretende referenciar outra fonte de informação (externa) prefira a utilização de “links”.
  • As tabelas podem aumentar imenso a legibilidade de dados estruturados. Se inserir uma tabela, assegure-se que os cabeçalhos têm sentido e representam claramente o conteúdo da tabela (e.g. “Tabela 1.2: Distâncias médias entre planetas”).
  • Tabelas grandes tendem a ser muito difíceis de editar. Considere antes representar os dados numa lista indexada.

Língua

  • Escreva frases gramaticalmente correctas.
  • Inicie cada frase com uma letra maiúscula e faça a adequada pontuação.
  • Tente escrever frases curtas e claras, sem recorrer em demasia a subordinação. Quando pensar que a página está completa, leia-a de novo e reveja cada frase que tenha uma estrutura mais complexa.
  • Decida como se dirigir aos seus leitores. Como o Dokuwiki é direccionado à escrita de documentação, frequentemente tem instruções aos leitores de como fazer certas coisas: Pode usar o imperativo ou exemplificar como fez. Não misture esses modos.
  • Verifique a gramática e ortografia antes de gravar. Se o texto tem muitos erros irá descredibilizar o conteúdo por muito bem pensado que o mesmo possa ser.
  • Desenvolva o seu estilo pessoal. Não se force a escrever duma forma desconfortável. Isso soará não natural e desagradável ao leitor.

Referências

  • Quando surge um termo que precisa ser explicado mais em detalhe, adicione uma página para esse termo e ligue-a.
  • Re-verifique a página antes de acabar e adicione as ligações para as páginas existentes.
  • Não adicione uma ligaçãi para cada ocorrência dum termo. Faça-o apenas na primeira ocorrência ou na mais relevante da página e eventualmente faça uma ligação na secção de referências.
  • Forneça ligações às fontes das imagens, dados e citações.
  • Considere adicionar uma linha “Ver também:” no fim da página. Faculte as ligações às páginas wiki directamente relacionadas com os tópicos abordados na página.
  • Se quiser apontar recursos externos com mais informação nos tópicos tratados ou que foram citados adicione uma secção chamada “Referências” ou “Informação adicional” no final e estabeleça as ligações adequadas(e.g. ISBN numbers). Se não o fez já no texto indique o âmbito da referência.
  • Definir atalhos “interwiki” pode ajudar a ligar recursos comuns.

Imagens e outros media

  • “Uma imagem diz mais que mil palavras.” Até pode significar mais do que se queria dizer. A autenticidade das imagens costuma ser menos questionada que o texto escrito. Uma descrição textual breve é melhor que nehuma ou que uma imagem inadequada.
  • Como com as tabelas, dê sempre um título às imagens, que defina o que pretende mostrar com a imagem.
  • Se a imagem não é sua, identifique a fonte (possivelmente uma ligação) e os copyright.
  • Não ligue imagens de sites externos, excepto se isso for explicitamente autorizado. Isto é uma questão primária de copyright mas pode ser também um consumidor de largura de banda quando o armazenamento temporário de imagens externas estiver desabilitado “caching for external images” .
  • Se a imagem é maior que cerca dum terço da página, use “link with resizing instructions” para inserir uma miniatura.
pt-br/tips/good_style.txt · Última modificação: 2012-11-21 00:17 por Klap-in