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.
Indice dei contenuti
- 1 Revisione degli articoli
- 2 Linee guida per la revisione e l'approvazione degli articoli
- 3 Che cos'è un aggiornamento dei contenuti esistenti?
- 4 Che cos'è una modifica importante?
- 5 Livelli di revisione
- 6 Feedback per i revisori
- 7 Revisione di più revisioni
- 8 Pronto per la localizzazione
- 9 Contenuti della prossima versione
- 10 Needs changes (Modifiche necessarie)
- 11 Assegnazione di credito
- 12 Spam e modifiche errate
Revisione degli articoli
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.
La Panoramica della Dashboard della Knowledge Base elenca gli articoli in ordine di visite negli ultimi 30 giorni. La colonna Stato mostra quali articoli necessitano di revisione. Tutte le revisioni degli articoli, non solo gli articoli principali, devono essere revisionate tempestivamente. Se una revisione non può essere approvata, deve essere rinviata con una spiegazione (vedi sotto). Il Content Manager della Knowledge Base di SUMO è responsabile di garantire revisioni tempestive.
L'elenco Modifiche non revisionate è un modo alternativo per vedere quali articoli necessitano di revisione, nonché quali revisioni sono in attesa di revisione da più tempo (è possibile ordinare l'elenco Tutti i prodotti in base a "Più recenti" oppure scegliere un prodotto specifico dall'elenco a discesa).
Articoli principali
I nostri articoli principali con più di 100.000 visite al mese (di cui circa 20 articoli per Desktop) rappresentano circa il 50-55% di tutte le visite alla Knowledge Base. I nostri articoli principali per Android sono quelli con più di 5.000 visite al mese.
È fondamentale che questi articoli contengano le informazioni più recenti e aggiornate.
Poiché gli articoli principali sono stati ampiamente modificati e interessano un gran numero di persone, è consigliabile discutere prima le modifiche più importanti. Sentitevi liberi di inviare un messaggio privato agli altri collaboratori della Knowledge Base per chiedere loro di intervenire. È meglio raggiungere un consenso, ma a volte è difficile da definire. Come sempre, usate il vostro buon senso.
- Per le modifiche importanti: non approvate la vostra revisione se si tratta di una modifica importante. Seguite le linee guida per l'approvazione degli articoli riportate di seguito. Se necessario, avviate una discussione nel thread di discussione dell'articolo.
Altri articoli
Gli articoli con meno di 100.000 visite al mese per Desktop (o quelli con meno di 5.000 visite per Android) rappresentano la stragrande maggioranza della nostra Knowledge Base (circa 600+ articoli; il 45-50% delle visite). Trattano problemi meno comuni e prodotti più recenti. Si prega di seguire le linee guida per l'approvazione degli articoli riportate di seguito.
Nuovi articoli
Quando creiamo un articolo per la prima volta, non riceve alcuna visita. Come lo gestiamo?
- Se l'articolo è stato creato per uno scopo specifico (lancio di Firefox Chemspill, per essere "linkato" da un prodotto o da mozilla.org), o è una risposta predefinita, trattalo come uno degli articoli più popolari.
- Se non abbiamo motivo di pensare che l'articolo sarà subito molto popolare, trattalo come gli altri articoli con meno di 100.000 visite Desktop o 5.000 visite Android al mese. Se la revisione rappresenta un miglioramento, approvala. Non preoccuparti se l'articolo non è completo al 100%. Se non è tra gli articoli più popolari, può iniziare a raccogliere feedback mentre è ancora in fase di elaborazione.
- Una volta che un nuovo articolo è stato approvato ma è stato pubblicato da meno di un mese, considera la possibilità di visualizzare la vista a 7 giorni.
Articoli speciali
- I modelli ("Templates") includono contenuti utilizzati in più articoli e devono essere considerati articoli principali. Tutti i modelli, compresi quelli che necessitano di revisione, sono elencati qui. Per ulteriori linee guida, consultare Come utilizzare i modelli.
- Le risposte predefinite ("Canned Responses") sono molto più importanti nel forum di supporto di quanto suggeriscano i numeri di visualizzazioni. Considera le nuove risposte del forum, o qualsiasi cosa che non sia una correzione o un chiarimento di minore entità, come una modifica importante. Tutte le risposte del forum, comprese quelle che necessitano di revisione, sono elencate in questa pagina. Per ulteriori linee guida, consultare Creare o migliorare le risposte comuni per il forum di supporto Mozilla.
Linee guida per la revisione e l'approvazione degli articoli
Creare contenuti di alta qualità su SUMO gioca un ruolo cruciale nel creare fiducia con i nostri utenti e nel consolidare la nostra credibilità. Per garantire che tutti i contenuti soddisfino elevati standard di qualità, accuratezza e coerenza, abbiamo implementato un requisito di revisione per tutti i contenuti della Knowledge Base, indipendentemente dall'autore.
Ogni volta che viene apportata una revisione a un contenuto della Knowledge Base, questa deve essere sottoposta ad almeno un ciclo di revisione. Questa revisione può essere condotta da un membro dello staff o da un collaboratore, a seconda del prodotto specifico. Anche i contenuti creati dai nostri membri dello staff devono essere sottoposti a questo processo di revisione, sebbene l'approvazione stessa possa avvenire al di fuori di SUMO per i membri dello staff.Per ulteriori chiarimenti, di seguito forniamo informazioni su quali prodotti richiedono esclusivamente l'approvazione dello staff e quali possono essere approvati dai co-contributori.
Aderendo a queste pratiche di revisione e approvazione, possiamo garantire che i contenuti di SUMO mantengano un elevato livello di qualità e accuratezza, fornendo ai nostri utenti informazioni affidabili e preziose.
Linee guida per la revisione dei contenuti
Tutti i membri del personale interno sono tenuti a far revisionare i propri contenuti in lingua inglese (en-US) da almeno un'altra persona. Esempi di revisori dei contenuti possono includere responsabili del supporto prodotti, responsabili di prodotto, responsabili legali, marketing, PR o collaboratori della community.
Le revisioni dei contenuti possono essere effettuate all'interno di SUMO o all'interno di un documento Google. Se il tuo contenuto è stato sottoposto a revisione al di fuori di SUMO, aggiungi semplicemente una nota nella tua revisione SUMO, menzionando il team o le persone che hanno espresso il loro apprezzamento. Vedi un esempio qui sotto.
Si prega di non autoapprovare le proprie revisioni (solo en-US), a meno che non si stia correggendo un errore in un contenuto precedentemente approvato o modificando dettagli minori che non influiscono sulle istruzioni. Si prega di attendere che un altro collaboratore o membro dello staff esamini altre modifiche ai contenuti (vedere livelli di revisione, qui sotto).
Le Revisioni recenti per en-US e le Modifiche non revisionate saranno riviste almeno tre volte a settimana dallo staff e dai collaboratori. Le revisioni in sospeso dovrebbero essere approvate o rinviate senza la necessità di essere contattati. Se non vi è un motivo critico per un'approvazione immediata, dovrebbe trascorrere un periodo di tempo ragionevole (sette giorni o più) prima che un editor contatti lo staff o un altro revisore, se l'approvazione dello staff non è necessaria.
Potrebbero esserci eccezioni in cui determinati contenuti richiedono la revisione e l'approvazione dello staff. In queste situazioni, l'autore indicherà nelle note di revisione la dicitura "Staff review required". Se proponi una revisione a uno di questi articoli, assicurati di segnalarlo all'attenzione di un redattore (tramite messaggio diretto SUMO o Slack), in modo che possa fornire la revisione e l'approvazione necessarie.
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!
Matrice dei requisiti di revisione
Prodotto | Autoapprovazione En-US | Approvazione co-contributore En-US | Approvazione solo staff En-US |
Firefox desktop | No | Sì | No* |
Firefox per Android/iOS | No | Sì | No* |
Focus Android/iOS | No | Sì | No* |
Thunderbird | No | Sì | No* |
Firefox per aziende (ESR) | No | Sì | No* |
Account Mozilla | No | No | Sì |
* A meno che l'autore non indichi "Staff approval required" nelle note di revisione.
Articoli con requisiti speciali
Articolo | Autoapprovazione En-US | Approvazione del co-contributore En-US | Approvazione solo dello staff En-US |
Come personalizzare le impostazioni di Firefox Suggest | No | No | Sì |
Prodotti in abbonamento/Premium
Si prega di non autoapprovare le proprie revisioni o approvare le revisioni di altri collaboratori (solo in inglese). Questo include le risposte predefinite e i modelli per i prodotti in abbonamento/premium. Se proponi una revisione, segnalala a un membro dello staff per l'approvazione (tramite messaggio diretto/privato SUMO, Matrix o Slack).
Lavorando insieme e assicurandoci che gli autori dello staff siano coinvolti nel processo di approvazione dei contenuti premium dei prodotti, possiamo continuare a migliorare i nostri contenuti per i nostri clienti.
Matrice dei requisiti di revisione
Prodotto | Autoapprovazione | Approvazione dei co-contributori | Approvazione solo dello staff |
Mozilla VPN | No | No | Sì |
Firefox Relay | No | No | Sì |
Monitor | No | No | Sì |
No | No | Sì | |
MDN Plus | No | No | Sì |
Hubs | No | No | Sì |
Conformità alle linee guida di revisione
Creare contenuti coerenti, accurati e pertinenti è importante, ma non è l'unico passaggio del processo. Per garantire che i nostri contenuti mantengano la loro qualità nel tempo, è necessario che tutti i soggetti coinvolti comprendano e seguano i processi di revisione e approvazione. Il nostro staff monitorerà attentamente il rispetto delle nuove linee guida per garantire che tutto proceda come previsto.
Per mantenere l'autorizzazione a svolgere il ruolo di Revisore della Knowledge Base:
- Rispettare le linee guida di revisione di cui sopra.
- Rispettare le Linee guida per la partecipazione alla community.
- Revisionare almeno tre (3) revisioni di articoli al mese.
L'autorizzazione a svolgere il ruolo di Revisore della Knowledge Base può essere revocata se si autoapprovano contenuti in lingua inglese (en-US) o se non si revisionano revisioni di articoli per un periodo prolungato di 60 giorni o più. I revisori saranno contattati dallo staff per determinare se sussistono validi motivi di non conformità, prima che venga intrapresa qualsiasi azione per revocare l'autorizzazione. Adottando questo approccio, incoraggiamo il lavoro di squadra, garantiamo i migliori contenuti possibili e creiamo un ambiente in cui le competenze di tutti contribuiscono al nostro successo.
Che cos'è un aggiornamento dei contenuti esistenti?
L'attività più comune nella Knowledge Base è mantenere aggiornati gli articoli. In genere, questo include:
- Correzioni ortografiche e grammaticali
- Semplificazione del linguaggio esistente, rimozione di termini tecnici
- Aggiornamento o aggiunta di screenshot
- Aggiornamento o aggiunta di screencast
- Rimozione di contenuti per le versioni di Firefox non più supportate
- Aggiornamento delle istruzioni passo passo per supportare le nuove versioni di Firefox
- Aggiornamento del testo esistente per supportare le modifiche nelle nuove versioni di Firefox
- Risoluzione di problemi con il markup wiki
- Correzione dei link
- Aggiornamento delle parole chiave
- Aggiunta o aggiornamento di un riepilogo di ricerca
Che cos'è una modifica importante?
Le modifiche importanti sono quelle che modificano radicalmente l'articolo esistente. Includono:
- Aggiunta di una nuova sezione
- Rimozione di una sezione esistente
- Riscrittura estesa (più che semplificazione e rimozione di termini tecnici)
- Riscrittura dei titoli delle sezioni
- Riordino delle sezioni
- Modifica dell'ambito dell'articolo
Livelli di revisione
Quando approvi un articolo, puoi scegliere tra tre diversi livelli di revisione:
- Minor details that don't affect the instructions (Dettagli minori che non influiscono sulle istruzioni): si tratta di modifiche che non modificano 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 è l'opzione predefinita. Si tratta di modifiche significative (aggiornamenti e modifiche sostanziali) che non invalidano completamente la versione precedente dell'articolo.
- Major content changes that will make older translations inaccurate (Modifiche importanti ai contenuti che renderanno imprecise le traduzioni precedenti): questa opzione è disponibile nel raro caso in cui un articolo sia così errato che, senza queste modifiche, causerebbe gravi problemi agli utenti. Questo aggiungerà un avviso sugli articoli localizzati che il contenuto potrebbe non essere aggiornato e fornirà un link alla versione inglese.
Feedback per i revisori
Quando si approva un articolo, è importante ringraziare i revisori 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? Faglielo sapere!
Se una revisione contiene più di un semplice errore, rappresenta una modifica importante a un articolo principale che non è stato discusso o è qualcosa che non ritenete utile, dovreste rinviare l'approvazione. Piuttosto che un semplice rifiuto, tuttavia, un rinvio è un'opportunità per collaborare con il revisore per preparare la revisione all'approvazione. Pertanto, ringrazia la persona che ha effettuato la modifica e fornisci un feedback specifico e costruttivo su ciò che ritieni debba essere modificato affinché la revisione sia accettabile. Oltre al campo commenti quando rinvii una revisione, puoi anche aggiungere una discussione al forum di discussione dell'articolo con informazioni più dettagliate e indirizzare il revisore al forum di discussione dell'articolo. Assicurati di fornirgli i link a eventuali discussioni o linee guida pertinenti all'articolo.
Revisione di più revisioni
Approvare l'ultima revisione non significa approvare anche le revisioni precedenti in attesa di revisione. Quando ci sono più revisioni in attesa di approvazione, assicurati di controllarle tutte prima di decidere se approvarne una. Non puoi rivedere le revisioni precedenti quando una revisione più recente è stata approvata. Vedrai che sono ancora in attesa di approvazione, ma non sarà possibile rivederle.
Pronto per la localizzazione
Contrassegnare una revisione di un articolo come "Ready for localization" (Pronto per la localizzazione) ci consente di comunicare ai localizzatori (traduttori in altre lingue) che la versione inglese è pronta e può essere tradotta senza il timore che l'articolo subisca ancora qualche modifica.
Quando si approva una revisione, se tutte le modifiche necessarie (note sulle modifiche necessarie, forum di discussione dell'articolo) sono state apportate e non ne sono previste altre (per la versione corrente o successiva), contrassegnare l'articolo come pronto per la localizzazione.
La localizzazione richiede molto lavoro e spesso viene svolta da una sola persona. Solo i primi 20 articoli circa vengono localizzati in alcune lingue. I nostri articoli principali in genere non necessitano di modifiche, a parte gli aggiornamenti per una nuova versione di Firefox. Poiché sappiamo che cosa succederà, cerchiamo di assicurarci che tutte le modifiche necessarie vengano apportate prima di un rilascio di Firefox, in modo che i localizzatori possano sfruttare quel tempo extra per completare il loro lavoro.
Se non contrassegni una revisione come pronta per la localizzazione al momento dell'approvazione (come nel caso precedente), puoi contrassegnarla come pronta in qualsiasi momento cliccando sulla voce di stato "Not ready for localization" (simbolo X) nella colonna R della cronologia delle revisioni dell'articolo e confermando.
Le revisioni contrassegnate come RFL (Ready For Localization) sono contrassegnate da un segno di spunta.
Come funziona "Ready for localization" (RFL)?
Per evitare che qualcuno traduca un articolo in fase di elaborazione, quando fai clic su "Traduci articolo", ti viene fornita la versione più recente contrassegnata come pronta per la localizzazione. Una volta approvata una nuova revisione di un articolo, l'articolo non viene aggiunto alle dashboard di localizzazione come necessitante di aggiornamento, a meno che la revisione non sia contrassegnata con il secondo o il terzo livello di revisione E il flag "pronto per la localizzazione" non sia selezionato. In questo modo, viene inviata anche una notifica via email a tutti coloro che stanno cercando articoli pronti per la localizzazione.
Contenuti della prossima versione
Gli articoli con contenuti della prossima versione sono nuovi articoli o modifiche di contenuto ad articoli esistenti, che riguardano funzionalità introdotte nella prossima versione. Le seguenti linee guida si applicano agli articoli con contenuti relativi alla versione:
Tempistica di modifica della Knowledge Base basata sulla versione
4 settimane prima della prossima versione
- Pianificazione e stesura dei contenuti per la prossima versione; nessun lavoro ancora per i localizzatori per la prossima versione
- Tutti i contenuti esistenti sono aperti alla modifica e alla localizzazione come di consueto; concentrati sulla localizzazione dei contenuti più recenti/popolari
3 settimane prima della prossima versione
- I contenuti della prossima versione saranno completati entro la fine di questa settimana; nessun lavoro ancora per i localizzatori per la prossima versione
- Tutti i contenuti esistenti sono aperti alla modifica e alla localizzazione come di consueto; Si prega di concentrarsi sulla localizzazione dei contenuti più recenti/popolari
1-2 settimane prima della prossima versione
- Le modifiche ai contenuti della prossima versione sono state apportate in en-US/inglese e i localizzatori dovrebbero concentrarsi sulla traduzione di questi contenuti
- Tutti gli altri contenuti esistenti sono stati declassati, ma possono essere modificati e localizzati come di consueto
Needs changes (Modifiche necessarie)
Quando si approva una revisione, è necessario decidere se e cosa debba ancora essere modificato. Se tutto ciò che è specificato nel commento "Needs changes" è 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, possiamo tenere facilmente traccia del lavoro da svolgere sugli articoli.
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, puoi modificare l'elenco dei collaboratori di un articolo (nella pagina della cronologia dell'articolo) per includerli. Punti bonus per aver fatto loro sapere che l'hai fatto!
Per aggiungere un collaboratore, vai alla pagina Show History (Visualizza storico) di un articolo. Scorri verso il basso sotto le revisioni e clicca sul link "Edit contributors" (Modifica collaboratori), digita il nome del collaboratore e poi fai clic su
(Aggiungi collaboratore).Spam e modifiche errate
In caso di spam, dovresti semplicemente eliminare la revisione facendo clic sul simbolo del "cestino" nella cronologia delle revisioni dell'articolo e confermando. In caso di invii errati (nessuna modifica) e richieste di supporto fuori luogo (la modifica è fondamentalmente una domanda di supporto), dovresti rigettare la modifica e includere questo messaggio nei tuoi 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, puoi eliminare la revisione.