Linee guida per la revisione degli articoli

Contributors Contributors Ultima modifica: 3 settimane fa

I nostri revisori della Knowledge Base sono collaboratori e personale di Mozilla con esperienza e competenza nella redazione di documentazione di supporto. Ecco alcune linee guida per la revisione degli articoli.

Scopo

In qualità di revisore della Knowledge Base, il proprio ruolo è essenziale per mantenere l'accuratezza, la chiarezza e la coerenza dei contenuti di supporto nella Knowledge Base di Mozilla. Il lavoro di revisione garantisce che gli utenti possano fidarsi degli articoli e trovare aiuto facilmente.

Responsabilità principali

In qualità di revisore della Knowledge Base, quando si revisiona una modifica, assicurarsi sempre che la revisione:

  • Sia accurata e aggiornata.
  • Utilizzi un linguaggio e un tono chiari e coerenti.
  • Sia in linea con le linee guida editoriali di Mozilla.
  • Includa formattazione, link e markup corretti e funzionanti.
  • Segua le migliori pratiche di accessibilità e localizzazione.
  • Rispetti l'ambito dell'articolo e la versione del prodotto.

Linee guida per la revisione

Nota: queste linee guida per l'approvazione si applicano solo alla revisione degli aggiornamenti in lingua inglese (en-US). Non si applicano agli aggiornamenti tradotti in altre lingue. Per ulteriori informazioni sulla localizzazione dei contenuti, consultare la guida Tradurre un articolo.

La maggior parte delle revisioni viene effettuata da persone che offrono volontariamente il loro tempo e le loro capacità. Quando si esamina il lavoro inviato, si presuppone che tutti abbiano le migliori intenzioni e si raccomanda di ringraziare per il contributo. Ricordate che si potrebbe essere il primo e unico contatto che quella persona ha con qualcuno di Mozilla. Vi preghiamo di essere positivi.

Criteri di revisione della Knowledge Base

Per gli aggiornamenti importanti, è importante distinguere tra approvazione dei contenuti e revisione dei contenuti, poiché si tratta di due processi separati.

  • L'approvazione dei contenuti viene eseguita dalle parti interessate del prodotto principalmente per convalidare l'accuratezza tecnica del contenuto.
  • La revisione dei contenuti viene eseguita dai revisori della Knowledge Base per garantire la qualità editoriale e la formattazione dell'articolo.

Per ulteriori dettagli su questa distinzione, leggere Assegnazione dei collaboratori per le richieste di contenuti.

Quando è richiesta la revisione da parte dello staff?

La revisione da parte dello staff è richiesta per:

  • Nuovi articoli.
  • Aggiornamenti importanti contrassegnati esplicitamente con "Staff review required" nelle note di revisione.

Quando i collaboratori con autorizzazioni di revisione della Knowledge Base possono revisionare le modifiche?

Importante: non è consentita l'autoapprovazione da parte di alcun collaboratore in nessun tipo di revisione.

I collaboratori con autorizzazioni di revisione della Knowledge Base possono revisionare:

  • Revisioni classificate come modifiche minori.
  • Modifiche importanti che non richiedono la revisione da parte dello staff.

Per ulteriori informazioni su come vengono classificati gli aggiornamenti dei contenuti in base al loro ambito e impatto, leggere la guida Modifiche minori e maggiori agli articoli della Knowledge Base.

Nota: tutte le revisioni con aggiornamenti importanti devono essere accompagnate da un ticket di richiesta di contenuto su Bugzilla. Se si riscontra un aggiornamento importante senza un ticket Bugzilla, in qualità di revisore della Knowledge Base è possibile contattare l'autore della revisione per richiedere l'invio di un ticket Bugzilla.

Dove trovare gli articoli non revisionati

Esistono diversi modi per trovare gli articoli non revisionati:

  • Panoramica della Knowledge Base: questa pagina fornisce un elenco di articoli in ordine di numero di visualizzazioni negli ultimi 30 giorni. La colonna Stato mostrerà quali articoli necessitano di revisione. È anche possibile filtrare in base al prodotto e al tipo di articolo.
  • Modifiche non revisionate: questa pagina fornisce un modo alternativo per vedere quali articoli necessitano di revisione, nonché da quanto tempo ogni revisione è in attesa di essere revisionata. È possibile scegliere di ordinare in base alle visualizzazioni/modifiche più recenti ed è anche possibile filtrare in base al prodotto.
  • Più visitati: questa pagina fornisce un elenco di articoli della Knowledge Base in base al numero di visualizzazioni. Nella colonna Stato, sarà possibile vedere quali articoli necessitano di revisione.

Priorità

Quando si revisionano più articoli, è importante dare priorità ai propri sforzi in modo strategico. Considerare quanto segue:

  • Articoli con un numero elevato di visualizzazioni: gli articoli con un numero elevato di visualizzazioni devono avere la priorità per garantire che gli utenti accedano alle informazioni più accurate e aggiornate. È possibile identificarli facilmente ordinando l'elenco delle modifiche non revisionate per numero di visualizzazioni.
  • Articolo collegato all'interno del prodotto: se si fa parte di uno dei gruppi di contributo (Forum, KB, L10n) o del gruppo "Staff", è possibile che venga visualizzato un indicatore che mostra che un articolo è collegato all'interno del prodotto. Questi articoli dovrebbero avere generalmente la priorità, poiché hanno un impatto diretto sull'esperienza dell'utente.
    in-product KB indicator

Articoli speciali

  • I modelli ("Templates") includono contenuti riutilizzati in più articoli e dovrebbero essere considerati di alta priorità a causa del loro impatto più ampio. Tutti i modelli, compresi quelli che necessitano di revisione, sono elencati in questa bacheca. Per le linee guida su come utilizzare i modelli all'interno degli articoli, fare riferimento a Come utilizzare i modelli.
  • Le risposte predefinite ("Canned Responses") sono risposte standardizzate utilizzate nei forum della comunità. Poiché vengono riutilizzate di frequente, qualsiasi aggiornamento deve essere coordinato con il team della comunità. Un elenco di tutte le risposte del forum, comprese quelle che necessitano di revisione, è disponibile in quest'altra bacheca. Per ulteriori linee guida sulla creazione o il miglioramento delle risposte comuni, leggere l'articolo Creare o migliorare le risposte comuni per il forum di supporto Mozilla.

Requisiti speciali per i prodotti in abbonamento o premium

Invio di contenuti

Importante: i collaboratori non possono inviare direttamente aggiornamenti o creare nuovi articoli della Knowledge Base per i prodotti in abbonamento o premium.

Se si desidera suggerire nuovi contenuti o proporre modifiche, si prega di inviare un ticket su Bugzilla o contattare un membro dello staff. È possibile contattare lo staff su Matrix o nel canale #sumo-team su Slack (per i collaboratori con accesso a Slack).

Revisione e approvazione delle revisioni della Knowledge Base

L'approvazione dello staff è richiesta per tutte le revisioni relative ai prodotti in abbonamento o premium. Ciò include le risposte predefinite e i modelli associati a questi prodotti.

Come riferimento, gli attuali prodotti in abbonamento o premium includono:

  • Mozilla VPN
  • Firefox Relay
  • Mozilla Monitor
  • MDN Plus

Revisione degli articoli

Scelta dei livelli di revisione

Quando si approva un articolo, è possibile scegliere tra tre diversi livelli di revisione. Questi livelli determineranno la necessità e la priorità per la localizzazione.

  • Minor details that don't affect the instructions (Dettagli minori che non influiscono sulle istruzioni): si tratta di modifiche che non cambiano le istruzioni per gli utenti. I localizzatori non riceveranno notifiche di queste modifiche.
  • Content changes that don't require immediate translation (Modifiche ai contenuti che non richiedono una traduzione immediata): questa è la scelta predefinita. Si tratta di modifiche importanti (aggiornamenti e grandi cambiamenti) che non invalidano completamente la versione precedente dell'articolo. I localizzatori non verranno informati immediatamente delle modifiche, ma la revisione potrà essere contrassegnata come "Ready for Localization" (Pronta per la localizzazione) in un secondo momento e ciò attiverà la notifica per i localizzatori.
  • Major content changes that will make older translations inaccurate (Modifiche importanti ai contenuti che renderanno imprecise le traduzioni precedenti): questa opzione può essere utilizzata quando l'aggiornamento renderà obsoleto il contenuto precedente. Contrassegnare un articolo con questa opzione attiverà un avviso sugli articoli localizzati che il contenuto potrebbe non essere aggiornato e fornirà un link alla versione inglese per le informazioni più aggiornate.
    Revision level updated

Lasciare un feedback per i redattori

Quando si approva un articolo, è importante ringraziare i redattori per il loro contributo. È anche utile poter fornire loro un feedback. Il loro stile è migliorato? Hanno fatto un lavoro particolarmente buono nello spiegare qualcosa di complesso? Farglielo sapere!

Nota: se una revisione è buona ma contiene un errore minore (errore di battitura, errore di markup, ecc.), è possibile approvarla e chiedere al redattore di risolvere il problema. Altrimenti, è anche possibile inviare una nuova revisione per correggerlo e chiedere a un altro revisore della Knowledge Base di revisionarla.
editor feedback

Deferring (Rinvio) di una revisione

Se una revisione non è particolarmente utile, è possibile rinviare la revisione proposta. Piuttosto che un semplice rifiuto, tuttavia, un rinvio è un'opportunità per collaborare con l'autore della revisione per migliorarla. È possibile farlo lasciando un messaggio nel campo dei commenti per ringraziare l'autore e quindi fornire un feedback specifico e costruttivo su ciò che si ritiene debba essere modificato affinché la revisione sia accettabile. Assicurarsi di includere anche i link a eventuali documenti o linee guida pertinenti.

kb deferral

Revisione di più revisioni

Quando ci sono più revisioni in attesa di approvazione, assicurarsi di controllare tutte le revisioni a partire dalla più vecchia prima di prendere una decisione. È importante notare che non è possibile revisionare le revisioni più vecchie quando una revisione più recente è stata approvata. Si vedrà che sono ancora in attesa di approvazione, ma non sarà possibile revisionarle.

Modifiche necessarie

Quando si approva una revisione, si deve decidere che cosa deve ancora essere modificato (se necessario). Se tutto ciò che è specificato nel commento "Needs change" è stato preso in considerazione, è possibile deselezionarlo (cancellando il commento) e approvare l'articolo. Se ci sono ancora cose da fare, assicurarsi che la casella di controllo sia selezionata e aggiornare il commento. In questo modo, si può tenere facilmente traccia del lavoro da svolgere sugli articoli.

Needs change

Assegnazione di credito

A volte le persone che partecipano a una discussione su un articolo apportano contributi significativi a una revisione, anche se non sono state loro a modificare il wiki. In casi come questo, è possibile modificare l'elenco dei collaboratori di un articolo (nella pagina della cronologia dell'articolo) per includerli. Punti bonus per aver fatto loro sapere di averlo fatto!

Come assegnare credito a un collaboratore nella Knowledge Base

  • Per aggiungere un collaboratore, andare alla pagina Show History (Visualizza storico) di un articolo
  • Scorrere verso il basso sotto le revisioni e fare clic sul link Edit contributors (Modifica collaboratori)
  • Digitare il nome del collaboratore e quindi fare clic su Add Contributor (Aggiungi collaboratore)
Nota: a tutti coloro che hanno inviato una revisione verrà automaticamente assegnato il credito, a meno che la loro revisione non venga rinviata.

Gestione di spam e modifiche errate

In caso di spam, è sufficiente eliminare la revisione facendo clic sull'icona del cestino nella cronologia delle revisioni dell'articolo e confermando. In caso di invii errati (nessuna modifica) e richieste di aiuto fuori luogo (la modifica è fondamentalmente una domanda di supporto), si dovrebbe rinviare e includere questo messaggio nei commenti:
Ciao.
Sembra che tu stia cercando di ottenere assistenza per Firefox. In tal caso, ti preghiamo di porre nuovamente la tua domanda qui, https://support.mozilla.org/questions/new, in modo che possiamo aiutarti meglio.
Ci scusiamo per l'inconveniente.

Una volta fatto, è possibile eliminare la revisione.

DeleteKBspam

Nota: non è possibile eliminare un articolo non approvato che è spam o una richiesta di supporto eliminandone le revisioni. Segnalare questi articoli a un amministratore.

Pronto per la localizzazione

Come funziona "Ready For Localization" (RFL)?

Per evitare che i collaboratori traducano un articolo che è ancora in fase di aggiornamento, il sistema consente la traduzione solo delle versioni che sono state esplicitamente contrassegnate come Pronta per la localizzazione (RFL). Quando il localizzatore fa clic su Translate article (Traduci articolo), gli viene fornita la revisione più recente che è stata contrassegnata come RFL.

Dopo l'approvazione di una nuova revisione, l'articolo non apparirà nelle dashboard di localizzazione come bisognoso di un aggiornamento, a meno che non sia selezionato il flag Pronta per la localizzazione (RFL). Quando il flag RFL è impostato, il sistema invia anche una notifica via email a tutti coloro che seguono l'articolo, informandoli che l'articolo è pronto per essere localizzato.

Contrassegnare un articolo come RFL

Contrassegnare una revisione di un articolo come "Pronta per la localizzazione" significa che si sta comunicando ai localizzatori che la versione inglese è terminata e può essere tradotta senza timore che l'articolo cambi ancora qualche volta prima che abbiano finito.

RFL update
Nota: la colonna "Ready for L10N" nella dashboard della Knowledge Base indicherà "No" per gli articoli con modifiche di contenuto approvate che non sono stati contrassegnati come pronti per la localizzazione. Questi articoli saranno elencati anche nella pagina Modifiche non pronte per la localizzazione.

La localizzazione è un lavoro impegnativo e spesso viene svolta da una sola persona. Non è sempre facile, ma si dovrebbe cercare di assicurarsi che tutte le modifiche richieste siano state apportate prima del rilascio di una versione di Firefox, in modo che i localizzatori possano utilizzare quel tempo extra per portare a termine il loro lavoro.

Nota: ricordare che se si contrassegna una revisione come aggiornamento minore, non c'è l'opzione per contrassegnare l'articolo come pronto per la localizzazione perché i localizzatori non vengono informati delle modifiche con questo livello di revisione.

Contrassegnare un articolo come RFL dopo la revisione

Se non si contrassegna una revisione come pronta per la localizzazione al momento dell'approvazione (come nel caso precedente), è possibile contrassegnarla come pronta in qualsiasi momento facendo clic sulla voce di stato "Not ready for localization" (simbolo ) nella colonna R della cronologia delle revisioni dell'articolo e confermando.

ReadyForLocalization3

Le revisioni che sono state contrassegnate come RFL hanno un simbolo di spunta .

Protocolli RFL

Tutti i revisori collaboratori devono attenersi ai seguenti protocolli di localizzazione:

  • Tutto lo staff di Mozilla e i revisori collaboratori possono contrassegnare un articolo completamente nuovo o un aggiornamento di un articolo come pronto per la localizzazione.
  • Tutti gli articoli completamente nuovi e le revisioni che introducono informazioni nuove o modificate devono essere contrassegnati per la localizzazione, se non diversamente specificato dai team di prodotto in base alla disponibilità regionale.
  • Se una revisione non altera le istruzioni, l'accuratezza o l'esperienza dell'utente, la priorità di localizzazione deve essere diminuita di conseguenza.
  • In alcuni casi, lo staff di Mozilla può lasciare una sintassi di commento o un commento di revisione in un articolo per indicare che una traduzione è già stata inviata per la localizzazione interna in alcune lingue. Se la sintassi del commento indica che un articolo o una revisione è già in fase di localizzazione interna, i collaboratori non devono localizzarlo autonomamente.

Pronto per il rilascio

Per assicurarsi di essere pronti a supportare le imminenti versioni "on-train" di Firefox, ecco alcune linee guida relative alle tempistiche per la preparazione al rilascio. Gli articoli associati alla prossima versione sono nuovi articoli o aggiornamenti di contenuti che coprono le funzionalità introdotte nella prossima versione. Le seguenti linee guida si applicano agli articoli con contenuti relativi al rilascio.

Calendario dei rilasci di Firefox

Nota: è possibile trovare un programma di rilascio per Firefox qui.

4 settimane prima del prossimo rilascio

  • Iniziare la pianificazione e la stesura dei contenuti per il prossimo rilascio; nessun lavoro ancora per i localizzatori.
  • Tutti gli articoli esistenti rimangono aperti per la modifica e la localizzazione come di consueto.

1-2 settimane prima del prossimo rilascio

  • La bozza dei contenuti per il prossimo rilascio potrebbe essere pronta internamente; tuttavia, la pubblicazione di solito attende la data di rilascio ufficiale per tenere conto di eventuali modifiche dell'ultimo minuto.
  • Se il contenuto richiede la localizzazione prima del rilascio, il team di prodotto deve informare lo staff CX in modo da potersi coordinare con la comunità di localizzazione per garantire il rispetto delle scadenze.

Giorno del rilascio

  • Le modifiche ai contenuti dovrebbero essere pubblicate nella Knowledge Base in lingua inglese (en-US). I localizzatori dovrebbero dare la priorità alla traduzione degli articoli relativi alla nuova versione.

Canale di discussione e escalation

Non tutti i revisori della Knowledge Base monitorano attivamente le Discussioni KB. Se si ha bisogno di raggiungere l'intero gruppo di revisori della Knowledge Base, si prega di inviare un'email a kb-reviewers@mozilla.com.

Valutazione del ruolo

Creare contenuti accurati, coerenti e pertinenti è importante, e mantenere tale qualità nel tempo richiede standard condivisi e un allineamento continuo.

In qualità di revisore della Knowledge Base, si svolge un ruolo importante nel sostenere tali standard. Per garantire che il nostro gruppo di revisori rimanga attivo e allineato con le pratiche attuali, il team della comunità conduce una leggera revisione annuale basata sulla partecipazione e sull'adesione alle linee guida.

Per mantenere l'autorizzazione di revisore della Knowledge Base, si chiede di:

  • Rimanere allineati: aderire alle Linee guida per la partecipazione della comunità e alle linee guida per i revisori della Knowledge Base descritte in questo articolo.
  • Rimanere attivi: revisionare almeno tre (3) revisioni entro un periodo di sei mesi.

Se non si è stati attivi o se sorgono domande sull'adesione alle linee guida, il team della comunità potrebbe contattare l'utente per un controllo prima di intraprendere qualsiasi azione. Il nostro obiettivo non è rimuovere le autorizzazioni, ma garantire che i revisori si sentano coinvolti, supportati e allineati con i processi attuali.

Se le circostanze cambiano e si ha bisogno di fare un passo indietro, lo comprendiamo perfettamente. Poiché si tratta di un ruolo volontario, il tempo e la disponibilità possono naturalmente cambiare. Non esitare a informare il team della comunità quando ciò accade. Siamo sempre felici di riconnetterci quando si è pronti a impegnarsi di nuovo.

Lavorando insieme e coinvolgendo altri nel processo di revisione e approvazione, possiamo mantenere i più elevati standard di qualità e garantire che i nostri contenuti siano di prim'ordine. Grazie per la collaborazione e continuiamo a creare revisioni straordinarie per i nostri utenti!

Questi bravi collaboratori hanno contribuito alla scrittura di questo articolo:

Illustration of hands

Collabora

Impara e condividi la tua esperienza con gli altri. Rispondi alle domande e migliora la nostra Knowledge Base.

Ulteriori informazioni