Ajuda:Como criar artigos no Wiki

De Wiki Locaweb
(Redirecionado de Como criar artigos na Wiki)
Ir para: navegação, pesquisa


Este artigo deve ser utilizado como referência para uniformizar os artigos da Wiki da Locaweb. As regras propostas não são obrigatórias. Há várias boas formas de se fazer algo, mas se todos fizerem da mesma forma esta Wik i vai se tornar muito mais fácil de consultar, manter e expandir.

A redação clara, informativa e correta é sempre mais importante do que a apresentação e a forma. Não se requer que os autores sigam todas ou alguma destas regras: a graça da edição wiki é que não se requer perfeição. Quem criar e editar artigos da Wiki da Locaweb irá procurar este pequeno manual e gradualmente serão feitas páginas que se ajustam a este guia, ou este guia será mudado e melhorado para o mesmo efeito.

Como este documento considerado é uma recomendação, ele ficará protegido, mas por favor não hesite em dar sugestões sobre como melhorá-lo pela página de discussão.


Título dos artigos

A escolha do título para um artigo é o primeiro passo na criação de um novo conteúdo. Seguem algumas dicas:

  • De preferência, o título deve descrever o assunto a tratar de forma objetiva e sem ambiguidade. Evite mesmo um título enorme.
    • Evite também colocar título como: "Ao clicar em um botão, aparece uma mensagem de erro: blablabla blablabla blablabla blablabla blablabla blablabla blablabla blablabla blablabla blablabla blablabla blablabla blablabla" Isso cansa quem está procurando algo objetivo. Se o artigo é sobre a solução de um erro, procure colocar o código deste erro no título e os pontos principais da mensagem, não ela toda.
  • Cuidado com o uso de letras maiúsculas. Elas não devem ser usadas no título inteiro.
  • Lembre-se: A Wiki não é somente uma base de FAQ (Frequently Answer Question). Logo, os títulos dos artigos não precisam necessariamente ser uma pergunta.
  • Dar nome a um artigo não deve ser feito sem antes parar para refletir. Se um nome for bem escolhido, mais fácil será para encontrar nas buscas, evitando que se criem outras páginas sobre o mesmo assunto e obtendo o consenso da comunidade.
  • Não use o ponto de exclamação (!) no título dos artigos. Não tem sentido e dificulta na pesquisa.

Antes de criar um novo artigo sobre determinado assunto, certifique-se que não existe já outro artigo sobre o mesmo, eventualmente com um nome menos adequado. Utilize a caixa de pesquisa para sua procura.

Da mesma forma, quando estiver escrevendo um artigo e pretender criar uma ligação interna para outro (usando a sintaxe: [[nome do artigo]] ), tenha o cuidado de verificar se o nome que usou para a ligação corresponde ao artigo pretendido. Se não existir um artigo com esse nome, quando alguém seguir essa ligação será criado um artigo. Se o nome for mal escolhido o novo artigo vai ter um mal começo: haverá mais hipóteses de "falhar" o artigo quando forem criadas ligações internas, aumentando a probabilidade de serem criados artigos diferentes sobre o mesmo assunto.

Tudo isto faz com que seguir convenções coerentes de nomenclatura dos artigos seja essencial para que as ligações internas sejam o mais simples e eficientes possível.

Parágrafo introdutório

Todos os artigos devem ter um parágrafo introdutório no qual se define brevemente o assunto a ser tratado.

Após isso, pode seguir dando a explicação ou solução do assunto.

Ligações internas

Ao escrever sobre qualquer assunto para a Wiki da Locaweb os nomes, palavras, ou frases que você considera que devam ser referidos como informação adicional deverão ser colocados entre dois parêntesis rectos ou colchetes, de forma a ter dois antes e dois depois do nome, palavra ou frase. Desta forma, será feita uma ligação interna entre esse nome, palavra ou frase no artigo que está editando e um outro artigo com esse título.

Exemplo: Existem pessoas mal intencionadas que utilizam técnicas aprimoradas para enviar e-mail forjando o remetente das mensagens, técnica também conhecida como [[Spoofing]].

Resultado: Existem pessoas mal intencionadas que utilizam técnicas aprimoradas para enviar e-mail forjando o remetente das mensagens, técnica também conhecida como Spoofing.

O uso das ligações internas para outros artigos é encorajado. Use em todas as palavras e termos em que a consulta do artigo ligado ajude na compreensão ou aprofunde o artigo que está editando. No entanto, um excesso de ligações internas numa página tem um efeito inestético, por isso não abuse delas. Por exemplo, não coloque uma ligação em todas as ocorrências de uma mesma palavra: basta ligar a primeira.

As ligações internas que seguem esta sugestão de nomenclatura têm maior probabilidade de ligarem a artigos já existentes, mas se ainda não existir um artigo sobre esse assunto, torna mais provável a criação de um artigo com nome correto por futuros editores. Tente criar as ligações com precisão. Se o artigo para o qual você quer criar a ligação ainda não existe, faça uma pequena busca para verificar: pode ocorrer que o nome do artigo seja ligeiramente diferente do que o que você digitou. Daí pode corrigir a ligação.

Muitas vezes o título do artigo não é o mais adequado para incluir como ligação interna. Nesses casos, é possível indicar um texto alternativo que será apresentado no artigo, mantendo a ligação o mesmo destino. Isso se faz escrevendo o texto alternativo após o título da ligação interna, separado por uma barra vertical (|).

Exemplo: Para confirmar a origem do email nesses casos é necessário analisar o [[O que é o cabeçalho de uma mensagem, e como obtê-lo?|cabeçalho]] da mensagem recebida.

Resultado: Para confirmar a origem do email nesses casos é necessário analisar o cabeçalho da mensagem recebida.

Tenha em atenção que o nome usado para a ligação interna deve ser suficientemente claro para que o leitor perceba do que trata sem ter que seguir a ligação. Nunca use coisas como "clique aqui" para o texto de uma ligação interna — isto não fornece informação nenhuma. O texto da ligação deve evidenciar ser o assunto tratado no artigo ligado.

Correto: Consulte a lista de programas de FTP que também são de SFTP.

Errado: Existem programas de FTP que também são de SFTP, veja a relação aqui.

Títulos das seções do artigo

Para dividir um artigo em seções, coloque o título da seção entre dois sinais de igual, como em: ==Esta é a primeira seção==.

Para fazer uma subseção, use ===Texto=== para o segundo nível e ====Texto==== para o terceiro.

Com os títulos formatados desta forma, o índice do artigo é gerado automaticamente. As seções são automaticamente numeradas para os utilizadores com essa definição ativada, e as palavras usadas nos títulos das seções têm maior relevância nas pesquisas (buscas). Os títulos também ajudam os leitores, partindo o texto e delineando o artigo de forma lógica.

Seguem-se algumas normas para a formatação de seções:

  1. Assim como os nomes dos artigos, use maiúsculas apenas na primeira letra da primeira palavra ou em nomes próprios.
  2. Evite fazer ligações dentro dos títulos das seções.
Dependendo das definições, alguns utilizadores podem não lê-los claramente. Recomenda-se antes colocar a ligação na primeira frase imediatamente a seguir ao cabeçalho.
  1. O abuso de subtítulos deve ser evitado, pois faz o artigo parecer desordenado.
Parágrafos curtos e frases soltas geralmente não garantem o seu próprio subtítulo.
Apenas nestas circunstâncias, quando não houver texto suficiente para justificar uma seção ou subseção, é preferível usar texto em negrito ou outras marcas dentro de uma secção em vez de subtítulos.

Seção Veja também

Na Locaweb, sempre será como subseção própria

Para todos os artigos da Wiki, devem ser listadas no final do artigo numa seção dedicada, intitulada "Veja também" as referências a outros artigos relacionados ao assunto.

Esta seção deve aparecer antes da seção "Links", que, obviamente, fica no fim do artigo. Não devem ser incluídas na seção "Veja também" ligações que já tenham sido incluídas no texto do artigo nem referências externas, quer dizer, que não sejam da própria Wiki da Locaweb.

Exemplo de como digitar:
==Veja também==
* [[FTP]]
* [[SFTP e SCP]]
O resultado será:

Veja também


Seção Links

Nossa Wiki não é uma coleção de referências para páginas externas. Artigos só com links são muito mal vistos. No entanto, os artigos devem ser complementados, sempre que possível, com links para outras páginas da Internet.

Use sempre: ==Links==

Uma ligação para uma página externa pode ser composta de duas formas:

  1. Para apresentar por extenso o texto da ligação, basta escrever o URL.
    Exemplo: http://locaweb.com.br
    Resultado: http://locaweb.com.br
  2. Para substituir o URL por um texto mais adequado, escreve-se o URL e o texto que se deseja apresentar, tudo entre parênteses retos.
    Exemplo: [http://locaweb.com.br Locaweb]
    Resultado: Locaweb

O URL deve começar com http:// ou outro protocolo, como ftp://.

Alguns URLs são pouco estéticos e dão pouca informação sobre o seu conteúdo. Nesse caso é preferível que apareça um título com maior significado.

Exemplo: [http://registro.br/cgi-bin/nicbr/transf_titul Transferência da titularidade do domínio] é mais legível que [http://registro.br/cgi-bin/nicbr/transf_titul]
Resultado: Transferência da titularidade do domínio é mais legível que http://registro.br/cgi-bin/nicbr/transf_titul

E, caso se pretenda que apareça o URL, deve-se apresentá-lo o mais simples possível, de forma a ligar à página pretendida. Remova o index.html<code> no exemplo acima.

A versão para impressão da página apresenta todos os URL por completo, incluindo aqueles a que foi acrescentado um título, por isso nenhuma informação se perde.

URLs como notas de pé de página

Sem o texto opcional, uma referência externa aparece como uma nota de pé de página.

Exemplo: <code>Bem-vindo à Wiki da Locaweb [http://wiki.locaweb.com.br]
Resultado: Bem-vindo à Wiki da Locaweb [1]

Na wiki da Locaweb não recomendamos a utilização desse formato

Localização dentro do artigo

Este formato pode ser usado para incluir uma referência URL inline dentro do texto quando necessário e deve estar sempre no final do arquivo, depois da seção "Veja também". E mesmo que você tenha apenas um link para indicar, ainda assim use a chamada da seção no plural: "Links".

Exemplo de como digitar para ficar como uma seção no final do artigo:
==Links==
* [http://www.locaweb.com.br ''Site da Locaweb'']
* [http://blog.locaweb.com.br Blog Corporativo]
O resultado será:

Links



Exemplo de como digitar dentro do artigo:
Exemplo: Tire suas dúvidas em nosso [http://forum.locaweb.com.br, fórum].
Resultado: Tire suas dúvidas em nosso fórum.

No entanto, na maior parte dos casos é preferível agrupar todos os links no fim do artigo sob o título ==Links==

Tipos de arquivos

Se o link não for para um arquivo HTML, mas para, por exemplo, um *.pdf ou *.jpg, deve colocar-se essa informação para que o utilizador decida se quer abrir ou fazer o download em primeiro lugar.

Tamanho dos arquivos

Para links com arquivos grandes (por exemplo, um HTML com imagens embutidas), é útil assinalá-lo com uma nota, permitindo desse modo a quem tenha uma conexão lenta a opção de usar ou não.

Imagens

Quanto ao posicionamento e o tamanho das imagens, deve-se seguir o bom senso de estética para deixar o artigo claro e agradável ao leitor. Os critérios para isso ficam a gosto do autor original, apenas mude se o resultado final for relevante e se deixar o artigo evidentemente melhor (não mude para algo equivalente). Algumas recomendações:

  1. Quando possível, isto é, quando o objeto da imagem tem um sentido claro, deixe os objetos voltados para dentro do artigo; por exemplo: se a foto é de alguém olhando para um lado, evite colocar a pessoa olhando para fora. Se a foto é de um carro, evite colocá-lo "saindo" do artigo.
  2. Quando há imagens próximas verticalmente, intercale-as, colocando uma de um lado e outra de outro; isso dá um equilíbrio estético e evita parecer que o artigo está "pendendo" para um lado.
  3. Quando as recomendações acima não forem aplicáveis, prefira utilizar o "thumb" padrão, isto é, sem especificar o lado, assim a configuração padrão de cada usuário se encarregará de colocar a imagem no lugar de preferência (geralmente à direita). Por exemplo: [[Imagem:Bota.jpg|thumb|Uma bota.]] a imagem ficará alinhada automaticamente à direita.
  4. Evite amontoar muitas imagens.
  5. Não exagere nos tamanhos (nem tão grande, nem tão pequeno), prefira utilizar o tamanho padrão do modo thumb, isto é, omitir o tamanho. Use um tamanho menor quando a imagem estiver chamando mais atenção do que deveria e um tamanho maior para alguns casos em que a leitura do texto direta é relevante, por exemplo, em casos de mapas ou diagramas diretamente relacionados ao texto. Mas é fortemente recomendado o uso do thumb na grande maioria dos casos.
  6. Por regra, as fotografias e os gráficos devem ter legendas. No entanto, a legenda pode ser omitida se a própria imagem tiver uma legenda ou se for uma óbvia representação do tema do artigo.

Ortografia

Escreva as palavras corretamente. Se tiver dúvidas, consulte um dicionário. Palavras escritas incorretamente causam uma péssima impressão.

Evite gírias.

Termos em outras línguas

De preferência, em termos de outras línguas que não o português, utilize a formatação itálica. Assim:

"Sempre faça backup."

Quando tudo mais falhar

Se você se depara com um ponto delicado na redação de um artigo, por favor use outros recursos, como o Manual de Redação da Folha de São Paulo. Onde esta página difere das outras fontes, deve-se preferir o uso desta página, mas por favor sinta-se à vontade para acrescentar a esta página e manter uma discussão.

Mais simples ainda é olhar para um artigo de que você gosta e abri-lo para editar, para ver como os autores e editores fizeram. Você pode então fechar a janela sem salvar as alterações se quiser, mas observe enquanto estiver lá. Quase todos os artigos podem ser melhorados. Quem sabe você pode fazer isso?

Não exagere

Torna-se mais fácil retomar o desenvolvimento de um artigo por si ou por quem lhe suceder se não optar por exagerar nas marcações (ligações — internas ou externas, formatação, etc). Mesmo com as sugestões apresentadas, o editor deve ter em conta que qualquer marcação irá resultar numa determinada aparência quando for visualizada.

É mais fácil visualizar a Wiki, editar ou adicionar artigos, se não se complicar a marcação, mais do que o estritamente necessário para disponibilizar a informação de uma forma compreensiva e útil. O principal objetivo é conseguir uma enciclopédia da Locaweb útil, embora a facilidade de edição e manutenção dessa enciclopédia sejam os sucessores imediatos.

Entre outras coisas, isto significa que o editor não deve usar a marcação excessivamente, e fazê-lo conscientemente.

'Padronize. Não personalize.

Lembre-se que todos devem achar fácil participar.

Não se ofenda

Caso alguém altere aquele artigo que para você é como um filho, não pense o pior da pessoa que alterou. Tente entender o que fez com que ela mudasse o artigo. E mais do que isso, respeite as alterações caso elas estejam corretas. Se a informação está correta e só foi melhor formatada, não seja melindroso. A Wiki não é só sua. Ela é de todos. E quem ganha com isso somos todos nós.

Veja também

Links