Como Fazer um Excelente Artigo no Wiki

Como Fazer um Excelente Artigo no Wiki




Há muitas maneiras de escrever um artigo no Wiki. Este tópico descreve o que funciona melhor em Wikis como este.

 

Para postar um novo artigo, clique no link à direita Escrever um artigo.

Como Fazer um Excelente Artigo no Wiki

Um excelente artigo no Wiki fornece uma ou mais informações necessárias para o leitor com base no título e no primeiro parágrafo. Se você prometer descrever como implantar uma certa característica em um determinado ambiente, seu artigo deve ser conciso e sucinto descrevendo o ambiente e condições prévias, listar as etapas e descrever o estado final com diagramas, vídeos e outros materiais de apoio conforme necessário para que o leitor possa concluir a tarefa.

Para criar um excelente artigo no Wiki:

  • Identificar uma ou duas informações chaves que você deseja compartilhar.
  • Estabelecer o trabalho de terreno para o título: Como Fazer, Solução de Problemas, Conectando-se a < outro produto >, Guia de Introdução, etc.
  • Definir as expectativas para o artigo no parágrafo de abertura. Você vai caminhar através de uma instalação do SQL Server 2008 em um ambiente clusterizado usando um cluster de máquina de 64 bits, descrevendo as particularidades da interoperabilidade entre duas características, discutindo os prós e contras de chamar uma função de API sobre outro, fornece etapas de solução de problemas para um produto ou recurso ou discutir as características gerais de uma determinada implementação? Os leitores querem saber o que esperar.
  • Escrever de maneira concisaArtigos maiores não são melhores artigos. Se você pode fornecer as informações em 20 palavras, então 20 palavras é suficiente.
  • Use seu próprio estilo, mas não em detrimento da clarezaNós não somos robôs. Use seu próprio estilo, mas não deixe que ele atrapalhe o que você está tentando dizer. Proteja as informações!
  • Use palavras-chave de uso sobre o título e no corpo do texto. Não se preocupe com a otimização do mecanismo de pesquisa, basta incluir as palavras-chave sobre o assunto que você está escrevendo.
  • Fornecer referências onde necessário. Referência fornecer credibilidade, autoridade, exibições alternativas, acrescentando detalhes e muitas vezes melhorando a reputação do artigo.
  • Ter e expressar uma opinião. Se você preferir uma solução de implantação específica, descreva as alternativas que você explorou e porque você tem a preferência. Como uma maneira de chamar uma função de API sobre outra? Diga-nos porquê! Conte-nos sobre as coisas que você tentou que não funcionam. Pode parecer trivial para você, mas para outros pode não ser, os leitores querem saber.
  • Pedir a ajuda desejada. Se você quer que as pessoas adicionem cenários adicionais, scripts ou noutras informações, que eles saibam.
  • Contribuir com ousadia, editar suavementeVocê pode ser o criador do artigo, mas uma vez publicado a Comunidade poderá alterá-lo. Se a ortografia e a gramática não são perfeitos, a Comunidade irá eventualmente intervir e irá alterá-lo.
  • Conecte os artigos. Sempre que necessário, vincule a partir de seu artigo para a facilidade o acesso.

Se você atender uma necessidade, os leitores encontrarão seu artigo.

Tipos de Artigos

Seu artigo poderá preencher muitos tipos diferentes de necessidades. Aqui estão alguns tipos de necessidades que você poderá encontrar:

  • Discussão. Este tipo de artigo apresenta diferentes opções, opiniões e pontos de vista. Se os leitores não concordarem com algum ponto, então eles irão adicionar seus próprios pensamentos e considerações sobre como uma opinião"alternativa" para as opiniões existentes. O objetivo é apresentar claramente todas as perspectivas. Exemplos.
  • Visão geral de alto nível. O objetivo é dar uma visão geral básica de um produto, teoria ou conceito geral. Se estão formando grandes subsecções, inicie um novo artigo e link para ele. Exemplos.
  • Como. Este tipo de artigo apresenta instruções tão claras e simples quanto possível. Exemplo: Como adicionar uma imagem ou vídeo.
  • Stub. Um pequeno artigo que você começa terá expansão. Criar um stub. Talvez você não tenha tempo ou conhecimento para escrever o artigo completo, mas você espera concluí-lo mais tarde ou que a comunidade possa concluí-lo. Exemplos.
  • Coleção de links. Um artigo que é principalmente uma coleção de links. Isso poderia ser um portal de Wiki (onde todos os links são para outros tópicos no TechNet Wiki) ou uma coleção de links externos (ou uma combinação).Certifique-se de é claro se são ou não as ligações para outros artigos do Wiki. Exemplos: Introdução,lista de produtos e tópicos relacionados.
  • Solução de Problemas. Uma lista de soluções para problemas comuns ao interagir com um produto específico ou interface. Exemplos.

Princípios de Design

Um excelente artigo, além do conteúdo adequado e bem elaborado, também deve seguir um padrão de estruturação e apresentação das informações. Cada item deste padrão, está descrito no artigo de Orientações da Experiência do Usuário. Contudo você pode ter sempre em mente os quatro princípios básicos do design:
  • Alinhamento. Mantenha somente um tipo de alinhamento no texto do artigo. Observe, por exemplo, que ao longo de todo este artigo, o texto está alinhado a esquerda. Elementos desalinhados em uma página passam a sensação de desordem.
  • Repetição. Quanto maior a repetição, mais o leitor identifica automaticamente o conteúdo que ele está buscando. Este é um principio que ajuda a estruturar o conteúdo. Observe que a repetição no artigo 'Como Fazer um Excelente Artigo no Wiki' foi utilizada nos seguintes elementos:
    • Os títulos possuem o mesmo padrão de apresentação: Segoe Ui, 18, Negrito
    • Todos os itens das listas, estão organizados igualmente: Titulo. Descrição
  • Contraste. Serve para destacar elementos diferentes. Observe que os títulos estão em Negrito e a Fonte é maior que o restante do texto.
  • Proximidade. A relação entre os elementos de uma página cria o todo da informação. Dessa forma, quanto mais próximos estiverem itens relacionados entre si, melhor a legibilidade. Imagine o quão confuso seria este texto, se não houvesse a aproximação do conteúdo relacionado e apenas tivéssemos o escrito sem quaisquer formatações.


Créditos

Esse artigo foi originalmente escrito em: http://social.technet.microsoft.com/wiki/contents/articles/115.wiki-what-makes-a-great-wiki-article.aspx
  

Veja Também

Outros Idiomas

Este artigo também está disponível nos seguintes idiomas:


Classificar por: Data da Publicação | Mais Recente | Mais Úteis
Comentários
  • Muito boa as dicas Luciano, estou aprendendo ainda, mas já ajudou demais.

  • Ana Paula de Almeida edited Revision 6. Comment: Inclusão dos Princípios do Design

  • Durval Ramos edited Revision 9. Comment: Adicionado "Outros Idiomas" e ajuste de Créditos

Página 1 de 1 (3 itens)