Pt:Diretrizes e orientações do wiki

From OpenStreetMap Wiki
Jump to navigation Jump to search
Sobre esta wiki Diretrizes e orientações Organização da wiki Tradução Projeto de limpeza Ajuda

O seguinte Wiki de diretrizes e orientações deve ser seguido ao se escrever páginas wiki. Isto irá ajudar a criar um wiki útil e de fácil utilização, que seja acessível à todos. O Projeto Enxugando o Wiki é uma página coordenando trabalhos no wiki, em parte para aumentar a comformidade com estas diretrizes.

Compreensibilidade

Mantenha as páginas curtas, use linguagem acessível e evite jargões. O OpenStreetMap pretende ser acessível para todos, e nossa documentação deve refletir isso. Direcione seu texto para o nível de crianças e avós!

Algumas páginas wiki naturalmente ganham forma de documentação técnica. Mesmo entre esses casos nós devemos procurar ser compreensível para usuários com uma gama de abilidades técnicas. Escreva introduções simples para guiar para um tópico, e considere dividir detalhes muito complexos para páginas wiki separadas e mais focadas.

Estrutura

O wiki deve ser organizado para permitir que as pessoas encontrem facilmente o conteúdo que eles estão procurando, começando da Página Principal. Tem links de algum conteúdo chave direto da Página Principal, mais outros links da pagina principal te levam a outras 'páginas iniciais' de um assunto em particular. Eles são o próximo nível em um tipo de hierarquia de navegação. Elas muitas vezes são páginas curtas com muitos links mas sem muito texto (também conhecidas como 'portais'). É necessário trabalho para garantir que esta navegação ainda está funcionando efetivamente para novos visitantes.

Informação conflitante

Informação conflitante é muito ruim. Informações sobre etiquetagem atual deve ser consistente. Se este não for o caso, por favor entre em contato com outros usuários para chegar a um consenso. Recomendações de etiquetagem idealmente devem bater com a prática atual de etiquetagem, a não ser que haja uma razão válida para não fazê-lo.

Propostas e alterações propostas para etiquetagem são as exceção a esta regra. Elas entretanto devem estar claramente identificadas como propostas.

Duplicidade

Duplicidade geralmente é ruim pois arrisca prover informação conflitante e aumenta a quantidade de trabalho. Onde houver duplicidade desnecessária, ela deve ser organizada para prover uma fonte única e clara de informação. Isso talvez requeira discutir com outros usuários! Não tem problemas em fazer um resumo de um tópico em outra página, mas este resumo deve ter um link para a página principal.

Template:merge é uma pré-definição usada para etiquetar páginas que requeiram reorganização para remover duplicidade.

Onde duplicidade for útil (por exemplo: está sendo apresentada em um diferente estilo, estrutura de página ou para audiências diferentes), é importante ser deixar claro do porque disso, e fazer links cruzados para evitar confusões. Se não houver uma boa razão para duplicidade, então as páginas devem ser mescladas. Note que uma mescla não significa necessariamente que ficaremos com uma só página onde antes haviam duas. Existem outras possibilidades, por exemplo uma página com resumo para leigos pode ter um link para uma página mais detalhada e técnica.

Títulos - convenção de nomeação de páginas

Favor seguir Convenções de capitalização de nomes do wikipedia(en): Para títulos de páginas com mais de uma palavra, deixe a segunda e as palavras seguintes com letra minúscula, a não ser que frase do título seja um nome próprio que sempre capitalizada, mesmo no meio de uma sentença.

Não use TítulosDePáginasGrudadosECaptalizados nos quais as palavras são juntadas, sem espaço - o MediaWiki nos permite usar espaços como na linguagem natural. A exceção desta regra seria o caso em que o título da página é o nome de alguma coisa que normalmente tem suas palavras juntadas, exemplo: "OpenLayers".

Prefixos numa página foram demasiadamente utilizados no passado (por exemplo: prefixo 'WikiProject'). Isto se dá principalmente por um incomodo legado, mas não um que não possamos facilmente retificar atualmente. Mover todas essas páginas seria uma enorme tarefa. Entretanto criar novos títulos de páginas com esquemas de prefixos é fortemente desencorajado. Use títulos de página em linguagem natural, e faça links cruzados num grupo de páginas para criar estrutura de links no conteúdo das páginas em si. Favor referir-se à organização do wiki para a discussão corrente deste tópico.

Introdução

As páginas devem iniciar com um breve parágrafo introdutório contendo algumas sentenças. Devendo incluir o título em negrito e explicando do que se trata a página. Geralmente é útil incluir um link para uma página mais genérica e pra quaisquer outras páginas mais específicas, pois facilita a navegação.

Esta seção introdutória deve aparecer antes de qualquer título(e antes da Lista de Conteúdo numa página longa). Note que é muito comum que pessoas criem um primeiro título "Introdução". Isso deve ser reestruturado para que ao menos parte da introdução esteja no topo da página, acima de qualquer título. Isso irá alcançar um layout consistente ao longo do wiki.

Vinculando

As páginas devem ser bem vinculadas (com links) para ajudar os usuários a encontrar a informação que eles estejam procurando. Conceitos correlatos importantes geralmente são vinculados entre si (com links) na introdução. Se você não consegue pensar em uma pagina wiki relacionada para vincular daqui, então você não deve estar descrevendo a página em termos suficientemente abrangentes. Você também é encorajado a vincular à conceitos relacionados ao longo do resto

Vinculando uma seção à uma página principal

O código {{main|page name}} pode ser usado sob um título de uma seção para fornecer um vínculo (link) para uma página principal relacionada ao assunto da seção. A seção deve então somente sumarizar a página 'principal' vinculada (e certamente não deve conflitar com ela de forma alguma). O título da página normalmente deve ser o mesmo da página ao qual está sendo vinculada.

Vinculando com o Wikipedia

Os links do Wikipedia podem ser confusos. Somente vincule com o Wikipedia se for útil, e se o conceito não for melhor explicado num contexto do OSM deste wiki.

Se usar a sintaxe entre wikis [[wikipedia:nome da página]], favor deixe aparente o prefixo 'wikipedia:', por exemplo: não faça texto de link alternado: [[wikipedia:nome da página|nome da página]] pois isso gera muita confusão a respeito de uma navegação básica. No entanto você pode usar uma predefinição (template) para deixar o vínculo externo à Wikipédia mais explícito: {{Wikipedia|pt|Nome da página}}, ou {{Wikipedia|pt|Nome da página|text= no }} para somente manter o ícone de direcionamento, sem o texto de atalho "no Wikipédia".

Não vincule à uma página do Wikipédia quando um título igual ou similar existir neste wiki (exceto do artigo deste wiki, onde ele pode ser usado como uma referência externa adicional para mais informações do mesmo tópico).

Página sobre um site da internet

Nós temos inúmeras páginas wiki dedicadas a descrever algum site externo (serviços de mapa, produtos de software, etc). Obviamente o vínculo externo para este site tem uma enorme importância. O vínculo deve ser posicionado entre colchetes após o título (que é em negrito) logo na primeira sentença e/ou vinculado em texto maior na sua própria linha depois das sentenças descritivas do topo.

Nestas páginas não tem porque duplicar boa parte da informação 'sobre' encontrada no site externo. A página deve descrever o site num contexto OSM. Seja mais neutro e menos promocional com suas descrições, no entanto procure usar um linguajar que promova o OSM e seus usos.

Softwares e serviços de listar

Nós temos uma quantidade de páginas contendo listas marcadas por pontos ou tabelas do wiki listando software / serviços. Se tivermos páginas wiki sobre o software, ou mesmo se não tivermos (vínculos vermelhos) o formato preferido é um vínculo interno à pagina do wiki do OSM seguido por um vínculo externo para o site em parenteses. Depois pode vir uma breve descrição ou outras colunas de tabela. Nós devemos procurar fornecer vínculos tanto para a página wiki quanto para a externa, mesmo quando a página wiki ainda não exista, para assim encorajar um nível saudável de vínculos internos. Vínculos vermelhos podem ser preenchidos com um rascunho de informações seguindo o conselho acima.

Vínculos externos de URL por extenso podem ser legais se forem curtos, uma vez que o usuário sabe o que esperar quando clicar nele. Deve ser usado um texto alternativo de vínculo para encurtá-lo, preferivelmente com o nome do domínio para que ainda fique claro que este é o vínculo externo.

Examplo:

Em situações de espaço muito restrito (frequentemente no caso de tabelas de wiki) nós podemos usar a sintaxe de vínculos numerados (por exemplo: [1]) para encolher o vínculo externo. Nós podemos optar por deixar de vincular externamente e apenas vincularmos a página wiki, já que ela em si terá o vínculo externo. Se a página wiki não existir nós podemos optar por somente fornecer um vínculo externo, mas pode ser melhor criar uma página wiki com um rascunho de descrição.

Categorias

Categorias devem ser usadas para agrupar páginas por tipo que devem seguir as mesmas convenções de nomes que as páginas wiki.

As categorias podem ser elas mesmas categorizadas para criar uma hierarquia que ajude a navegar ao assunto de interesse. Por exemplo: Category:Buses(categoria:ônibus) está categorizada dentro de Category:Public transport(categoria:transporte público).

As páginas podem fazer parte de um punhado de categorias mas não devem exagerar. Uma página relacionada a ônibus (por exemplo: uma página sobre paradas de ônibus) deve ser categorizada como 'Buses' mas não também como 'Public transport' mas não também como 'Public transport'(transporte público). No entanto, a página principal Ônibus também deve ser etiquetada com a categoria 'Public transport' assim como com a categoria mais específica.

Uma introdução de uma só linha deve ser fornecida para cada categoria na qual geralmente deve vincular à uma página 'principal' apropriada para o assunto, idealmente de mesmo nome. Por exemplo: 'Páginas relacionadas à [[Public transport]] como uma introdução à categoria 'Public transport'.

Quando forem categorizada, as páginas devem usar a opção de ordenar se necessário para garantir que elas apareçam apropriadamente na lista das páginas. Por exemplo, veja as páginas listadas em Category:Users in London(Categoria:Usuários em Londres). Todas elas seriam listadas sob 'U" por causa do prefixo 'User:', mas isto foi sobrescrito. Por exemplo, o User:Harry Wood tem a categoria de texto wiki: [[Category:Users in London|Harry Wood]] com a frase de ordenação fornecida depois de '|'.

Língua

O OpenStreetMap usa inglês britânico para páginas em inglês em geral, e inglês apropriadamente 'local' para páginas de tópicos locais. Logo para qualquer página que em essência diz respeito ao E.U.A., por qualquer motivo, usaria inglês americano. Essa regra particularmente se aplica à páginas de locais sob Projetos de mapeamento.

Tradução

Veja Tradução do wiki. Ela inclui alguns pensamentos filosóficos introdutórios sobre o que desejamos alcançar com traduções no wiki, enquanto não está claro se o wiki irá migrar para a Extensão de tradução.

Formatação de data

Nas páginas em inglês, as datas devem ser formatadas em um destes modos, dependendo da precisão necessária:

  • 12 August 2009 (o formato normal, a não ser que haja incerteza quanto ao dia, ou ele não seja tão relevante)
  • Wednesday 12 August 2009 (para quando o dia da semana importa)
  • 1 August 2009 (não há necessidade do zero à esquerda no valor do dia)
  • August 2006 (o dia do mês não é conhecido nem relevante)
  • 2009
  • 'Soon' (August 2009) (quando uma previsão foi feita em algum momento)

Sufixos ordinais (th, nd, rd) não são necessários, e dias e meses devem ser escritos por extenso. Evite datas incompletas que sejam confusas, e evite o uso de estações (verão no hemisfério norte é inverno no sul!).

Warning: Default sort key "Diretrizes e orientacoes do wiki" overrides earlier default sort key "Diretrizes e orientações do wiki".