Uma fonte deve permitir que você verifique uma afirmação sem adivinhar onde procurar. Vincule a proposta ao documento relevante com um texto compreensível e verifique se o conteúdo citado realmente oferece suporte ao texto. A acessibilidade das referências faz parte da qualidade editorial.

associar uma afirmação a uma prova

Durante a escrita, observe quais passagens são baseadas em documentação, observação ou exemplo ficcional. Nem sempre uma página inicial é suficiente para oferecer suporte a uma regra específica. Abra o documento e verifique seu escopo: produto, versão, território e data. Se a fonte não disser o que você escreve, corrija a frase ou procure uma referência mais adequada.

Escolha um rótulo compreensível

O W3C explica que o destino de um link deve ser entendido a partir de seu texto ou contexto específico. Um título ou descrição específica do documento ajuda mais do que uma sucessão de “Clique aqui”. Pense também no leitor que navega apenas nos links. Relate o formato ou idioma quando eles são úteis para antecipar o que será aberto.

Controle a ligação entre uma frase e seu documento

Para cada afirmação importante, faça três perguntas: qual passagem a suporta, em que escopo e com que atualidade? A documentação do produto pode descrever uma opção limitada para algumas versões. Um artigo geral pode explicar uma noção sem justificar a conclusão precisa que você tira dela. O link deve permitir essa verificação, não apenas dar uma aparência documentada à página.

Grade de verificação de referência
Aponte para verificarPergunta práticapossível correção
RelevânciaO documento realmente suporta a frase?Reformule ou escolha outra referência
PerímetroA versão e as condições correspondem?Adicione os limites aplicáveis
RealidadeO documento ainda é a referência atual?Verifique a nova documentação
DestinoO link abre o documento anunciado?URL correto, redirecionamento ou formato anunciado
TextoO leitor entende a utilidade do link?Substitua um título genérico por uma descrição

Os Critério W3C na função de link Ajuda a projetar uma navegação compreensível. O contexto da frase permanece importante, mas um título específico também facilita a consulta de uma lista de links. Quando o idioma ou o formato do documento alteram a experiência esperada, anuncie-a de maneira útil.

Evite referências decorativas

Uma longa bibliografia não compensa a ausência de uma ligação entre os fatos e os documentos. Coloque uma referência perto da passagem relevante e mantenha uma lista final curta para aprofundar. Não atribua a um autor uma conclusão que ele não formula. Se você propor um método de seu raciocínio, apresente-o como um método proposto, mesmo quando for baseado em documentação técnica.

Exemplo fictício: uma regra de redirecionamento

Um artigo descreve um comportamento do servidor e cita uma postagem geral sobre o redesenho. O gravador substitui essa referência pela documentação relevante, especifica a condição técnica e adiciona um exemplo de teste. Ele então verifica o link no teclado e no celular. O leitor, portanto, tem o contexto necessário para controlar a afirmação sem se perder em outro site.

Faça uma revisão editorial, não apenas uma verificação de status

  1. Abra o documento com o mesmo URL que o publicado. Uma página acessível a partir do seu histórico ou da sua conta não prova que o link público está funcionando.
  2. Leia a passagem em questão e suas condições. Um destino pode permanecer ativo enquanto muda de assunto ou versão.
  3. Controlar o teclado e os links móveis. Verifique se a etiqueta permanece compreensível e que a abertura não depende de uma interação frágil.
  4. Observe as referências a serem analisadas com a próxima evolução do assunto. As características e as interfaces do produto geralmente exigem um rastreamento diferente de uma definição estável.

Em um exemplo fictício, um artigo vincula uma explicação da canonização a um post geral sobre o redesenho. O bilhete pode ser interessante sem apoiar a regra técnica. A correção é citar a documentação relevante próxima à declaração e explicar as condições. Não consiste em acumular outros links no final da página até tornar a bibliografia mais longa.

A lista final pode manter os documentos principais e completar os links incorporados no texto. Deve permanecer proporcional ao assunto. Um Registro de fatos auditados Ajuda a encontrar os itens afetados quando uma fonte muda. Para conteúdo multilíngue, verifique também se os rótulos traduzidos anunciam os documentos corretamente, mesmo quando eles permanecem em seu idioma original. A existência de um link nunca substitui a verificação do que prova.

Quando as páginas existem em vários idiomas, o teste de aceitação de localização de SEO Completa o controle de referência. Em particular, verifica o significado dos termos, os links entre as versões e os documentos que permanecem em outro idioma.

Manter referências

Durante uma revisão, controle o status, redirecionamentos e conteúdo de destino. Um URL ainda ativo pode ter mudado de assunto. Mantenha a data de verificação e o revisor responsável. Links quebrados exigem uma correção editorial, não apenas uma substituição automática. Integre esse controle em seu rotina de reparo de links E verifique se as citações permanecem legíveis em trechos e formatos de compartilhamento.

Documentação complementar