In questo articolo vengono spiegati alcuni aspetti del funzionamento della Knowledge Base del SUpporto MOzilla (SUMO).
Indice dei contenuti
Che cos'è la Knowledge Base?
La Knowledge Base è un wiki con i super-poteri:
- Sintassi wiki specifica: sebbene venga utilizzata la sintassi MediaWiki (come quella di Wikipedia) nella maggior parte dei casi, il nostro wiki è progettato specificamente per il supporto a Mozilla e comprende anche una speciale istruzione (chiamata {for}) con la quale è possibile mostrare ad esempio un insieme di informazioni agli utenti Windows ma non agli utenti Mac.
- Sistema di revisione: poiché vogliamo sempre essere sicuri che gli utenti ricevano informazioni corrette e aggiornate, le modifiche ai nostri articoli devono essere revisionate e approvate prima che vadano online.
- Traduzioni: la maggior parte dei nostri utenti parla una lingua diversa dall'inglese, e perciò abbiamo un sistema per consentire la traduzione degli articoli dall'inglese in altre lingue.
Utenti e perimetro della Knowledge Base
Dal momento che i prodotti Mozilla vengono utilizzati da milioni di persone con diversi livelli di capacità, la Knowledge Base dovrebbe essere scritta per un pubblico generale più che per chi ha già familiarità con la terminologia tecnica relativa ai computer. Principalmente vengono trattate le caratteristiche dei programmi (come le schede, i segnalibri e Sync) e la risoluzione dei problemi (come i crash o difficoltà nel caricare le pagine web). Non viene trattato ogni aspetto, configurazione o problema, ma ci basiamo invece sul riscontro degli utenti (nelle discussioni relative agli articoli, nei forum di supporto e nel numero di visualizzazioni) e utilizziamo la nostra esperienza e giudizio per decidere esattamente di che cosa occuparci.
Quali sono gli argomenti di cui NON ci occupiamo nella Knowledge Base?
- Trucchi o modifiche avanzate dei prodotti
- Caratteristiche avanzate o destinate agli sviluppatori come la console degli errori o la console web
Organizzazione del lavoro
Come si stabiliscono le priorità?
Ci concentriamo sugli articoli a seconda della loro popolarità. Ciò generalmente rappresenta la priorità dei nostri utenti. Attualmente i 20 articoli più visitati assorbono più della metà delle visualizzazioni. Migliorando i nostri articoli più visitati può potenzialmente aiutare lo stesso numero di persone che possono beneficiare del miglioramento degli ultimi 100. Teniamo traccia delle modifiche da effettuare in questo pannello, ordinato secondo le priorità in modo da poter capire subito su quali articoli occorre lavorare prima.
Eccezioni:
Ovviamente la popolarità non è l'unica discriminante. Vengono tenute in conto anche queste eccezioni:
- Problemi critici: occasionalmente, nuovi problemi riportati nel nostro forum di supporto vengono gestiti meglio aggiornando tempestivamente un articolo.
- Richieste anticipate: occasionalmente aggiorniamo un articolo in previsione dell'introduzione di una nuova caratteristica o della modifica di una esistente. L'articolo in questione potrebbe non avere una priorità alta, ma siamo sufficientemente sicuri che diverrà popolare basandoci sull'esperienza e sulle previsioni di marketing.
- Documentazione per piattaforma mobile: i prodotti Mozilla per i dispositivi portatili, come ad esempio Firefox per Android e Firefox per iOS, hanno relativamente pochi utenti e gli articoli che li riguardano non possono "competere" in popolarità con quelli relativi a Firefox. Quindi questi numeri vanno comunque contestualizzati alla richiesta di informazioni e documentazione dello specifico prodotto.
- Link interni: articoli richiamati da altri prodotti o pagine presenti sul sito mozilla.org.
Priorità per i sistemi desktop
- Windows: essendo il 90% degli utilizzatori su piattaforma Windows, la presenza di immagini prese su questo sistema è fuori discussione. Per le schermate si preferisce Windows 10.
- Mac: la versione attuale è macOS 13.0 (Ventura) a partire dal mese di ottobre 2022.
- Linux: si preferisce Ubuntu per le schermate.
Piattaforma Mobile
- Android 4.0 o superiori (4.0, 4.1, 4.2, 4.3, ecc.).
Dove si discute degli articoli?
Generalmente le discussioni sono di due tipi:
- Singoli articoli: ciascun articolo ha il suo forum specifico per la discussione accessibile nel menu Strumenti di modifica ("Editing Tools").
Gli utenti registrati possono inserire commenti e suggerimenti per l'articolo e in questo spazio è possibile discutere su ciò che è possibile fare per migliorarlo. - Intera Knowledge Base: le nuove idee e le strategie relative a tutta la KB possono essere discusse nel forum delle discussioni della Knowledge Base.
Come rimanere aggiornati sullo stato dei lavori?
- Mozilla Support (SUMO) blog: in questo blog compaiono gli ultimi aggiornamenti di progetto e di sviluppo.
- Pagina dei collaboratori: un'altra importante fonte di informazioni aggiornata all'incirca ogni settimana.
- Discussioni della comunità di SUMO: in questo spazio i collaboratori possono discutere tra loro.
- Discussioni sugli articoli della KB: qui trovano spazio le discussioni generali sulla KB.
- Discussioni sulla localizzazione: in questo forum si discute della localizzazione di SUMO.
Aggiungere e rimuovere articoli
Proporre nuovi articoli
La nostra Knowledge Base è il risultato di tutto il nostro sforzo nel supportare centinaia di milioni di utenti di Firefox. La cosa più efficace che possiamo fare è rispondere alle domande degli utenti sui prodotti e i servizi di Mozilla con un articolo. Ma gli articoli hanno un loro costo. Ogni articolo deve essere scritto, localizzato e mantenuto. Con molte caratteristiche e problemi già documentati, spesso l'uso migliore del nostro tempo collettivo è quello di migliorare gli articoli esistenti. Prima di iniziare a creare nuovi articoli, è necessario soffermarsi su alcune considerazioni:
Abbiamo davvero bisogno di questo articolo?
Di seguito riportiamo i motivi principali che determinano l'aggiunta di un nuovo articolo alla Knowledge Base sebbene in molti casi avrebbe più senso aggiornare o integrare un articolo esistente.
- Nuove caratteristiche: quando ci si trova di fronte a caratteristiche che sono in grado di generare un grande interesse e numerose domande da parte degli utenti. Questo può essere un aspetto intrinseco di una caratteristica, il risultato di una strategia di marketing e di link interni al prodotto o una combinazione dei due fattori.
- Nuovi problemi: problemi che generano molte discussioni recenti e voti nel forum di supporto .
- Alto impatto: criticità e problemi sensibili che necessitano di documentazione temporanea (ad esempio un problema che riguarda il recupero dei dati utente mancanti dopo un aggiornamento di Firefox).
Archiviazione degli articoli
Procediamo all'archiviazione di alcuni articoli della Knowledge Base per concentrarci sulle esigenze più pressanti degli utenti. Poiché rilasciamo periodicamente versioni aggiornate dei prodotti Mozilla, i problemi e gli elementi che necessitano documentazione cambiano ad un ritmo molto più veloce. Ci saranno molti articoli (come ad esempio Segnalibri o Impostare la pagina iniziale) che rimarranno validi per molto tempo, ma ce ne saranno altri che diventeranno obsoleti o di scarsa utilità e interesse per gli utenti.
Come funziona l'archiviazione
I collaboratori con privilegi di revisione possono contrassegnare un articolo come obsoleto modificando l'articolo utilizzando la pagina Description (Descrizione) dell'articolo, a cui si può accedere utilizzando l'opzione
("Modifica metadati articolo") disponibile negli Strumenti di Modifica ("Editing Tools"). Ciò farà in modo di eliminare l'articolo da tutti i pannelli (compresi i pannelli di localizzazione) e dalla normale ricerca. Naturalmente verranno conservati i link relativi all'articolo. Tuttavia, verrà visualizzato un avviso sulla parte superiore dell'articolo archiviato che informerà l'utente che l'articolo non è più mantenuto e potrebbe non essere aggiornato.L'archiviazione di un articolo non è una procedura irreversibile. Anche quando un articolo è stato archiviato, continueremo a monitorarne le statistiche per assicurarci che esso non sia tra quelli maggiormente consultati. Se ci accorgiamo che l'archiviazione dell'articolo è stata un errore o inopportuna, l'articolo potrà essere facilmente reso di nuovo pubblico e disponibile nei pannelli aprendo nuovamente la pagina Editing Description (Modifica descrizione) e deselezionando la casella Obsoleto (per istruzioni dettagliate, leggere Modificare un articolo della Knowledge Base).
Fattori da considerare prima di archiviare un articolo:
- Bassa percentuale di visite: generalmente, gli articoli con meno di circa 1500 visite/mese.
- Poche segnalazioni recenti: problemi che presentano relativamente poche discussioni recenti e voti nel forum di supporto.
- Basso impatto: la rimozione dell'articolo non è in grado di causare o acuire un problema serio.
- Modifiche a prodotti e servizi: casi in cui un problema è stato risolto o un cambiamento nel comportamento ha reso obsoleto l'articolo.
Linee guida per la revisione di un articolo
Si rimanda alla lettura dell'articolo Article review and approval guidelines.
Linee guida complete della Knowledge Base
Se si è veramente interessati a modificare e scrivere documentazione, ecco alcune risorse che dovrebbero aiutare a capire come facciamo le cose
Creare nuovi articoli di supporto
- Writing guide for Knowledge Base articles: guida alle tecniche e agli stili di scrittura che utilizziamo per rendere gli articoli più coinvolgenti ed efficaci. Per i meccanismi di creazione o modifica effettiva degli articoli, vedere:
- Create a new Knowledge Base article: passaggi per la creazione di un nuovo articolo, insieme ad alcuni marcatori di esempio per iniziare.
- Anatomy of a Knowledge Base article: spiega le basi di come vengono costruiti gli articoli.
- Article Description: spiega come scrivere la descrizione per un articolo di supporto.
Migliorare gli articoli di supporto esistenti
- Improve the Knowledge Base: spiega come collaborare al miglioramento della Knowledge Base di SUMO.
- Modificare un articolo della Knowledge Base: riporta le procedure da seguire per modificare un articolo esistente.
Altre linee guida
- Come funziona la Knowledge Base: una panoramica dei meccanismi della nostra Knowledge Base (la guida che stai leggendo)
- How to make screenshots: una guida passo passo alla creazione di schermate da utilizzare negli articoli.
- Article review and approval guidelines: linee guida per i revisori della Knowledge Base.
- Add images and screenshots to Knowledge Base articles: spiega come aggiungere immagini agli articoli e visualizzarle correttamente.
- Marcatori più utilizzati della sintassi Wiki: i marcatori più comunemente utilizzati negli articoli della Knowledge Base.
- Sintassi Wiki: riferimento ai marcatori del wiki. Fornisce esempi e mostra il marcatore che li produce.
- Come utilizzare l'istruzione {for}: marcatore speciale che consente di mostrare le istruzioni per (for) diverse versioni dell'applicazione (ad esempio, Firefox 115) e sistemi operativi come Windows e macOS.
- Come utilizzare i modelli: i modelli sono parti di contenuto riutilizzabili. Si può includere una serie complicata di istruzioni dettagliate in più articoli utilizzando un unico modello.
- When and how to use keywords to improve an article's search ranking: spiega quando è appropriato aggiungere parole chiave a un articolo.
- Per visualizzare ulteriori linee guida sul contributo alla Knowledge Base, fare clic qui.