Help:Writing article introductions (Português)

From ArchWiki
Jump to navigation Jump to search
Status de tradução: Esse artigo é uma tradução de Help:Writing article introductions. Data da última tradução: 2018-10-30. Você pode ajudar a sincronizar a tradução, se houver alterações na versão em inglês.

Esse artigo foi escrito para auxiliar editores e escritores de wiki na criação de artigos efetivos e expande a experiência dos leitores do ArchWiki.

Você não é obrigado a saber como editar uma página wiki para seguir este artigo. Essa página é mais um guia de estilo mais genérico, em vez de um tutorial técnico de edição.

Introdução de artigo

A introdução do artigo é (geralmente) a primeira coisa que leitores encontram e tem o propósito de introduzi-los no tópico.

Cada artigo é iniciado com um conjunto de presunções. Essas presunções são raramente verdadeiras para a maioria dos leitores, e uma introdução de artigo possui o propósito de filtrar leitores que preenchem as presunções feitas por leitores. Você não precisa introduzir leitores sobre o resto do artigo, mas ela pode ajudar a esclarecer algumas coisas, que, do contrário, permaneceriam incertas mesmo ao ler todo o artigo... várias vezes.

Por exemplo, você pode ter escrito um artigo sobre configurar o sistema de uma certa forma. Porém, você presumiu que os leitores têm um Arch Linux limpo e recentemente instalado em seu disco rígido primário. Como seu método seria afetado se o kernel fosse, por exemplo, personalizado? Ou como faria com a etapa 3 se o pacote X estiver faltando?

Você precisa pensar sobre pré-requisitos para seu método e apresentar esses pré-requisitos antes de você iniciar seu artigo. Isso tem dois benefícios chaves:

  1. Isso permite leitores decidirem se eles desejam ler o artigo, antes que eles tenham ido longe demais.
  2. Isso permite que você escreva um artigo sem muitas digressões desnecessárias.

O segundo tem um impacto gigante no desempenho do leitor e torna o artigo mais direto ao ponto.

Há diversas coisas que você pode considerar incluir na introdução de seu artigo, mas aqui estão algumas das mais importantes em nenhuma ordem específica:

  • experiências anteriores e conhecimento exigido
  • configuração e estados de sistema
  • propriedade de componentes de hardware
  • o que os leitores não vão encontrar no artigo

O texto

Nós já mencionamos algumas coisas que você pode querer mencionar em uma introdução de artigo. Nós agora vamos olhar alguns problemas em formular uma introdução de artigo efetiva e útil.

Experiências anteriores e conhecimento

Ao falar sobre experiência anterior, você precisa ter em mente que há dois significados das palavras. Um é um significado mais geral. Nós podemos chamar algum de novato ou guru com base em conhecimento/experiência/reputação geral daquele indivíduo. O outro é uma experiência concreta de participar de um evento ou atividade (e o conhecimento derivado daquele). Por motivos práticos, é melhor demandar experiência(s) anterior(es) no segundo sentido. A maioria dos artigos no ArchWiki falam sobre tópicos que são específicos e em algum contexto. Em um dado contexto, um novato pode exibir proficiência, onde um guru pode mostrar falta de interesse. Se você exigir experiências anteriores específicas, leitores podem ter uma melhor chance de julgar suas habilidades de seguir o resto do artigo.

Você também pode desejar fornecer aos leitores links para os recursos que os ajudariam a ganhar conhecimento exigido para entender o artigo.

Configuração e estados de sistema

Em alguns casos, um pacote em falta ou um componente de sistema configurado de forma diferente podem resultar em um artigo inútil em alguns sistemas. Portanto, você precisa rastrear e definir toda configuração relevante do sistema (como parâmetros rc.config relevantes, pacotes necessários, etc) sempre que possível.

Requisitos de hardware

Requisitos de hardware geralmente são razoavelmente óbvios. Se você está falando sobre instalar drivers para modem de discagem XYZ, ninguém vai pensar que você está falando sobre um modem ZYX. Porém, em alguns casos, é bom mencionar requisitos específicos de hardware. Por exemplo, se você está escrevendo um artigo sobre instalar drivers para XYZ-123, você pode avisar os usuários que este pode não se aplicar a XYZ-456.

Também é um bom toque para adicionar a foto do hardware que seu artigo está prestes a discutir.

O que leitores não vão encontrar neste artigo

Em alguns casos, o título do artigo pode ser um pouco enganador. Portanto, você pode precisar avisar os leitores sobre o tópico real do artigo e, possivelmente, oferecer um link para outros artigos pelos quais leitores podem estar procurando.

Por exemplo, alguns leitores pensaram que esse artigo seria sobre como formatar páginas usando texto wiki. Portanto, esses leitores foram avisados que essa não é a página pela qual eles estavam procurando, e o link para a página correta foi fornecida.

Formatação

A formatação da introdução do artigo segue as normas do ArchWiki. Porém, ainda há alguns detalhes que merecem uma atenção mais cuidadosa.

Ao listar os requisitos, você tem duas abordagens. Uma é explicar verbalmente os requisitos e outras notas introdutórios com puro (seu idioma aqui). O outro método é oferecer uma lista bem organizada de requisitos.