Una fonte dovrebbe permetterti di verificare un'affermazione senza indovinare dove cercare. Collega la proposta al documento pertinente con una formulazione comprensibile, quindi controlla che il contenuto citato effettivamente supporti il testo. L'accessibilità delle referenze fa parte della qualità editoriale.

associare un'affermazione a una prova

Durante la scrittura, nota quali passaggi si basano sulla documentazione, sull'osservazione o sull'esempio immaginario. Una home page non è sempre sufficiente per supportare una regola specifica. Aprire il documento e verificarne l'ambito: prodotto, versione, territorio e data. Se la fonte non dice quello che scrivi, correggi la frase o cerca un riferimento più adatto.

Scegli un'etichetta comprensibile

Il W3C spiega che la destinazione di un collegamento deve essere in grado di essere compresa dal suo testo o contesto specifico. Un titolo o una descrizione specifico del documento aiuta più di una successione di "clicca qui". Pensa anche al lettore che sfoglia solo i link. Segnala il formato o la lingua quando sono utili per anticipare ciò che si aprirà.

controllare il legame tra una frase e il suo documento

Per ogni affermazione importante, poni tre domande: quale passaggio la supporta, in quale ambito e con quale attualità? La documentazione del prodotto può descrivere un'opzione limitata per alcune versioni. Un articolo generale può spiegare un'idea senza giustificare la conclusione precisa che ne traete. Il collegamento dovrebbe consentire questa verifica, non solo dare un aspetto documentato alla pagina.

Griglia di controllo di riferimento
punto da controllareDomanda praticaPossibile correzione
RilevanzaIl documento supporta davvero la frase?riformulare o scegliere un altro riferimento
PerimetroLa versione e le condizioni corrispondono?Aggiungi limiti applicabili
AttualitàIl documento è ancora il riferimento corrente?Controlla la nuova documentazione
DestinazioneIl link apre il documento pubblicizzato?URL, reindirizzamento o formato pubblicizzato corretti
FormulazioneIl lettore capisce l'utilità del collegamento?Sostituisci un titolo generico con una descrizione

Le Criterio W3C sulla funzione di collegamento Aiuta a progettare una navigazione comprensibile. Il contesto della frase rimane importante, ma un titolo specifico facilita anche la consultazione di un elenco di collegamenti. Quando il formato della lingua o del documento cambia l'esperienza prevista, pubblicizzala in modo utile.

Evita i riferimenti decorativi

Una lunga bibliografia non compensa l'assenza di un legame tra i fatti e i documenti. Posiziona un riferimento vicino al passaggio pertinente e mantieni un breve elenco finale per approfondire. Non attribuire a un autore una conclusione che non formula. Se proponi un metodo dal tuo ragionamento, presentalo come metodo proposto, anche quando si basa sulla documentazione tecnica.

Esempio fittizio: una regola di reindirizzamento

Un articolo descrive un comportamento del server e cita un post generale sulla riprogettazione. Il writer sostituisce questo riferimento con la documentazione pertinente, specifica la condizione tecnica e aggiunge un esempio di test. Quindi controlla il collegamento sulla tastiera e sul cellulare. Il lettore ha quindi il contesto necessario per controllare l'affermazione senza perdersi in un altro sito.

Fai una revisione editoriale, non solo il controllo dello stato

  1. Apri il documento con lo stesso URL di quello pubblicato. Una pagina accessibile dalla cronologia o dal tuo account non dimostra che il collegamento pubblico funzioni.
  2. Leggi il passaggio in questione e le sue condizioni. Una destinazione può rimanere attiva pur avendo cambiato argomento o versione.
  3. Controlla la tastiera e i collegamenti mobili. Verificare che l'etichetta rimanga comprensibile e che l'apertura non dipenda da un'interazione fragile.
  4. Nota i riferimenti da rivedere con la prossima evoluzione del soggetto. Le caratteristiche e le interfacce del prodotto spesso richiedono un tracciamento diverso da una definizione stabile.

In un esempio di fantasia, un articolo collega una spiegazione della canonizzazione a un post generale sulla riprogettazione. Il biglietto può essere interessante senza sostenere la regola tecnica. La correzione consiste nel citare la relativa documentazione vicino alla dichiarazione e spiegare le condizioni. Non consiste nell'accumulare altri link alla fine della pagina fino a quando non allunga la bibliografia.

L'elenco finale può conservare i documenti principali e completare i collegamenti incorporati nel testo. deve rimanere proporzionato all'argomento. Uno Registro dei fatti verificati Aiuta a trovare gli elementi interessati quando una fonte cambia. Per i contenuti multilingue, verifica anche che le etichette tradotte pubblicizzino correttamente i documenti, anche quando rimangono nella loro lingua originale. L'esistenza di un collegamento non sostituisce mai la verifica di ciò che dimostra.

Quando le pagine esistono in diverse lingue, il verifica di accettazione della posizione SEO Completa il controllo di riferimento. In particolare, verifica il significato dei termini, i legami tra le versioni ei documenti che rimangono in un'altra lingua.

mantenere i riferimenti

Durante una revisione, uno stato di controllo, reindirizzamenti e contenuti di destinazione. Un URL ancora attivo potrebbe aver cambiato argomento. Mantieni la data di verifica e il revisore responsabile. I collegamenti interrotti richiedono una correzione editoriale, non solo una sostituzione automatica. Integra questo controllo nel tuo routine di riparazione dei collegamenti e verifica che le citazioni rimangano leggibili in snippet e formati di condivisione.

Documentazione aggiuntiva