Qualità della lingua

Terminologia e glossari.

Tratta la terminologia come contenuto regolamentato con proprietari, stati, spiegazioni approvate ed eccezioni controllate.

Chiarire il compito e la decisione

Questa guida trasforma la terminologia e i glossari in un flusso di lavoro operativo rivedibile. Collega le decisioni di dominio, la proprietà, le prove e l'accettazione in modo che il risultato continui a funzionare in produzione.

Tratta la terminologia come contenuto regolamentato con proprietari, stati, spiegazioni approvate ed eccezioni controllate.

Procedura pratica

  1. 1

    Definisci il pubblico con prove, tra cui esperienza di lettura, contesto, dispositivo e supporto disponibile.

  2. 2

    Seleziona un compito reale e indica cosa deve capire o fare un lettore di successo.

  3. 3

    Crea la versione linguistica preservando ogni fatto, condizione, data e percorso di contatto rilevante per la decisione.

  4. 4

    Esegui revisioni specialistiche ed editoriali con criteri di accettazione registrati.

  5. 5

    Testare con i membri del pubblico previsto, registrare i risultati, rivedere e approvare il rilascio.

Esempio o strumento

Un glossario mostra i termini preferiti, proibiti e specifici del pubblico con la guida CMS. Nello strumento, registra anche la baseline, il proprietario, la decisione, le prove, il problema aperto e la data di approvazione. Utilizza una pagina o una transazione reale in modo che il team possa vedere le dipendenze, le eccezioni e il lavoro di manutenzione che segue il rilascio.

Punto decisionaleDocumentazioneCriterio di accettazione
Linea di baseStato attuale osservatoFonte e data registrate
DecisioneOpzione selezionata e motivazioneRischio e pubblico considerati
ProvaTestare, documentare o misurareRivedibile e specifico della versione
ApprovazioneNome, ruolo e dataTutti i criteri obbligatori sono soddisfatti

Rendi ogni termine un record regolamentato

Un glossario utile è più di un elenco di parole preferite. Ogni record deve contenere un identificatore stabile, un termine preferito, varianti vietate o deprecate, definizione, spiegazione del pubblico, forme grammaticali, esempi, modalità linguistica, dominio, proprietario, stato, data di approvazione, fonte e trigger di revisione. Mantieni la definizione tecnica separata dalla dicitura mostrata ai lettori. Una definizione interna precisa può supportare diverse spiegazioni specifiche del pubblico senza che i loro significati vadano alla deriva.

Utilizza stati espliciti: proposto, in corso di revisione, approvato, deprecato e proibito. Solo i record approvati vengono offerti agli autori o applicati da sistemi automatizzati. Un termine obsoleto rimane ricercabile in modo che i vecchi contenuti possano essere trovati e migrati. Un termine proibito include il motivo e la sostituzione approvata, il che aiuta gli editori a risolvere un avviso senza tirare a indovinare. Versionare ogni decisione e mantenere il valore precedente per l'audit e il rollback.

CampoEsempioRegola di accettazione
Termine preferitoufficio beneficiUn modulo approvato per dominio e modalità linguistica
Spiegazione del pubblicoL'ufficio che controlla e paga il tuo sussidioSignificato preservato e testato per il pubblico
StatoApprovatoProprietario, revisore e data di registrazione
EccezioneIl titolo del modulo ufficiale conserva la durata legaleAmbito, motivo e scadenza sono documentati

Esegui un flusso di lavoro ripetibile per la decisione sui termini

Raccogli i candidati dai registri di ricerca, dalle domande di supporto, dai commenti dei revisori, dalle modifiche alle politiche e dalle ripetute correzioni manuali. Prima di creare un nuovo record, cerca termini esistenti, varianti e concetti correlati. Il termine proprietario scrive la definizione e identifica la fonte autorevole. Uno specialista dell'argomento conferma il significato, un redattore propone la formulazione del lettore e uno specialista dell'accessibilità controlla le modalità linguistiche selezionate. Prova spiegazioni di grande impatto con i lettori previsti.

Il gruppo terminologico quindi approva, rifiuta o richiede prove. Dovrebbe riunirsi secondo un programma prevedibile e avere un percorso urgente per modifiche legali o di servizio. Le decisioni stabiliscono dove si applica il termine e dove no. Ad esempio, una pagina in un linguaggio chiaro può riportare la dicitura "ufficio benefici", mentre un campo di applicazione deve mantenere il nome dell'autorità statutaria. L'eccezione appartiene allo stesso record, quindi gli autori vedono entrambe le scelte nel contesto.

  1. 1

    Cattura il termine candidato e il contenuto in cui ha causato difficoltà.

  2. 2

    Conferma il concetto, il dominio, la fonte autorevole e il pubblico interessato.

  3. 3

    Bozza di formulazione preferita, spiegazione, varianti e linee guida sulla migrazione.

  4. 4

    Esaminare il significato, la modalità linguistica, l'accessibilità e l'impatto operativo.

  5. 5

    Approva e pubblica il record con versione, quindi aggiorna il contenuto interessato.

Integra la terminologia nella creazione e nella distribuzione

Esporre il glossario tramite un API o un repository sincronizzato con identificatori stabili. Lo CMS dovrebbe evidenziare i termini proibiti e deprecati, mostrare la sostituzione e la spiegazione preferite e consentire agli autori di aprire la decisione completa. I suggerimenti devono rispettare le impostazioni locali, il dominio, il tipo di contenuto e la modalità linguistica. Non sostituire le parole automaticamente quando la grammatica o il contesto legale possono cambiare significato. Richiedere a un autore di accettare il suggerimento o registrare un'eccezione regolamentata.

Memorizza la versione del glossario utilizzata per ciascuna revisione linguistica. Quando un termine approvato cambia, interroga CMS per i record interessati e crea attività di revisione in base al rischio. I controlli di anteprima possono bloccare nuovi termini vietati, spiegazioni mancanti sul primo utilizzo o un'eccezione scaduta. La consegna in fase di esecuzione non dovrebbe dipendere da una richiesta di glossario in tempo reale. Risolvi e convalida i termini prima della pubblicazione in modo che un'interruzione della terminologia non possa alterare o bloccare le pagine pubblicate.

  • I suggerimenti CMS utilizzano identificatori di termini stabili anziché la sola corrispondenza del testo.

  • Vengono rispettati il ​​luogo, il dominio, la modalità linguistica e la forma grammaticale.

  • I controlli automatici spiegano una risoluzione invece di limitarsi a segnalare un errore.

  • Le eccezioni hanno ambito, proprietario, prova e scadenza.

  • Una modifica al glossario crea attività di revisione per il contenuto pubblicato interessato.

Misurare l’adozione e risolvere i conflitti

Tieni traccia dell'utilizzo dei termini preferiti, dei nuovi risultati dei termini vietati, dei candidati irrisolti, del tempo medio di decisione, delle eccezioni scadute e dei contenuti in attesa di migrazione. Combinare queste misure operative con prove di comprensione e sostegno alla domanda. Un tasso di adozione elevato non dimostra che una spiegazione funzioni. Se i lettori continuano a fraintendere un termine approvato, riaprire la decisione e conservare le prove che hanno portato alla modifica.

Quando i dipartimenti necessitano di termini diversi, determinare se intendono lo stesso concetto. Se il concetto è diverso, crea record collegati con domini chiari. Se differisce solo il pubblico, mantieni una definizione di base e fornisci spiegazioni separate per il pubblico. Assegnare un amministratore terminologico per decidere le controversie sulla proprietà e impedire la duplicazione dei record. Rivedere i termini di maggiore impatto almeno una volta all'anno e ogni volta che cambiano la legge applicabile, il processo di servizio o lo standard linguistico selezionato.

Ruoli, prove e approvazione

La qualità della lingua è una responsabilità operativa. Assegnare al proprietario della fonte la responsabilità dell'accuratezza fattuale, all'editore la responsabilità della chiarezza, una responsabilità specialistica per le regole di accessibilità e al proprietario del prodotto la responsabilità della pubblicazione. Il record di rilascio dovrebbe identificare la versione originale, la modalità linguistica, i revisori, le prove del test, la data di approvazione e l'evento che attiva una nuova revisione.

Operazioni e manutenzione

Il lavoro non termina con la pubblicazione. Collega la versione o la configurazione linguistica alla sua fonte, monitora la qualità e le misure del servizio e definisce criteri concreti di revisione. I fattori scatenanti includono modifiche alla fonte, modifiche legali, nuove esigenze del pubblico, domande di supporto ricorrenti, modifiche tecniche e incidenti. Un proprietario nominato valuta il trigger, apre una nuova revisione quando necessario e registra la rinnovata approvazione.

Lista di controllo per la pubblicazione

  • Il pubblico e il compito sono espliciti.

  • Tutti i fatti legali e operativi corrispondono alla fonte.

  • Date, importi, condizioni ed eccezioni sono completi.

  • I titoli descrivono le domande o le azioni del lettore.

  • Collegamenti e controlli hanno etichette significative.

  • La terminologia specialistica è spiegata in modo coerente.

  • Il pubblico previsto ha testato il viaggio critico.

  • Vengono registrati la proprietà e l'attivazione della revisione successiva.

Fonti autorevoli

  1. Centro federale di competenza per l'accessibilità - facile da leggere e da capire
  2. DIN ISO 24495-1 linguaggio chiaro: principi guida e linee guida
  3. W3C - Rendere i contenuti utilizzabili per le persone con disabilità cognitive e di apprendimento

Metti in pratica la guida

Prova Simple8 con contenuti rappresentativi e utilizza la lista di controllo per pianificare un flusso di lavoro di produzione controllato.

Metti alla prova il tuo testo