Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Mautic
- Technical writer:
- Mi piace, Kelvin
- Nome progetto:
- Knowledgebase
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Abstract
Una knowledge base è un repository centralizzato in cui le informazioni vengono archiviate, organizzate e poi condivise. Se utilizzata esternamente, una knowledge base consente agli utenti di apprendere tutto ciò di cui hanno bisogno sui prodotti o servizi, sull'organizzazione e sul settore di un'azienda. Una knowledge base interna, invece, viene generalmente utilizzata per consentire alla community e agli utenti di collaborare e distribuire internamente tutte le conoscenze e le informazioni aziendali. I contenuti delle knowledge base specifiche variano in base a numerosi fattori, ma la maggior parte in genere include informazioni su come iniziare a utilizzare prodotti specifici, sfruttare al meglio le funzionalità avanzate e risolvere problemi o problemi comuni. Il vantaggio principale di creare e presentare una knowledge base al tuo pubblico è che ti consente di fornire informazioni approfondite, immediate e on demand e risposte ai membri/utenti/community del pubblico senza doverle fornire singolarmente.
Mautic Knowledge Base è un repository centrale per tutorial, guide illustrative e best practice su argomenti correlati a Mautic, sia direttamente (ad es. come fare le cose in Mautic) sia indirettamente (ad es. strategie di marketing più generali).
Al momento della stesura di questo articolo, la knowledge base Mautic è abbastanza nuova e incompleta e la community Mautic vuole usare questo progetto per migliorare il modo di fornire informazioni approfondite e on demand alla documentazione per gli utenti al fine di consentire agli utenti finali di avere un'esperienza senza soluzione di continuità durante l'utilizzo di Mautic. Attraverso la knowledge base Mautic è stato abbastanza istruttivo, ma aveva bisogno di tutorial e guide illustrative aggiornati anche per la creazione di nuovi, nonché per abbinare la versione Mautic 3x.
La mia prima impressione esaminando la documentazione esistente Al momento, la knowledge base Mautic è disponibile su https://kb.mautic.org/. Alcuni tutorial, guide illustrative e argomenti delle best practice presenti nella documentazione non sono aggiornati, sono scarsi o incompleti e non includono informazioni sulla versione corrente del codice Mautic.
Perché proponi di miglioramento rispetto alle aree attuali in cui vorrei contribuire? Il miglioramento proposto avrà lo scopo di migliorare e garantire efficienza, coerenza e tranquillità per qualsiasi utente finale. L'articolo conterrà tutorial scritti, guide illustrative e best practice e le immagini associate, oltre a istruzioni e spiegazioni su come utilizzare ciascuna funzionalità del sito, aggiornato, facile da esplorare e comprensibile.
Analisi
La knowledge base di Mautic è stata scritta in formato CMS a file flat Grav e nel tema KLB4. Ho fatto molte ricerche su come migliorare la documentazione della knowledge base
Obiettivi del progetto
- Esamina la knowledge base.
- Aggiorna i tutorial e le guide illustrative della versione Mautic 3x.
- Crea risorse per la knowledge base della Mautic Community appena creata
- Scrivi una serie di tutorial e guide illustrative che aiuteranno gli utenti di Mautic a impostare, configurare e utilizzare in modo più efficace l'applicazione.
- Aggiorna il tutorial video per adattarlo alla versione Mautic 3x.
- Rimuovi le immagini e le informazioni obsolete.
- Riscrivi la knowledge base per renderla più comprensibile.
- Garantisci la corretta implementazione della guida di stile/del modello della documentazione della knowledge base
Sequenza
Prima del 1° agosto
- Continua a dare contributi all'organizzazione.
- Acquisire familiarità con la documentazione della knowledge base e la versione attuale di Mautic.
- Apprendi nuove tecniche e competenze di scrittura tecnica che ti saranno utili durante l'implementazione del progetto.
Legami di comunità (1° agosto - 1° settembre)
- Configurare un canale di comunicazione e un orario (a causa della differenza di tempo)
- Perfeziona i miei obiettivi e definisci le aspettative per entrambe le parti
- Scopri di più sulla community e sul prodotto
- Discutere della struttura di documentazione proposta con i mentori e altri membri dell'organizzazione.
- Finalizza le funzionalità proposte e le altre modifiche da apportare alla documentazione esistente.
Periodo di documentazione
- Settimana 1 (2 settembre - 22 novembre)
- In questi periodi collaborerò direttamente con i miei mentori per :
- Esamina la knowledge base.
- Aggiorna i tutorial e le guide illustrative della versione Mautic 3x.
- Crea risorse per la knowledge base della Mautic Community appena creata
- Scrivi una serie di tutorial e guide illustrative che aiuteranno gli utenti di Mautic a impostare, configurare e utilizzare in modo più efficace l'applicazione.
- Aggiorna il tutorial video per adattarlo alla versione Mautic 3x.
- Rimuovi le immagini e le informazioni obsolete.
- Riscrivi la knowledge base per renderla più comprensibile.
- Garantisci la corretta implementazione della guida di stile/del modello della documentazione della knowledge base.
- Prendendo in considerazione la frequenza di rilascio, in quanto il team di sviluppo si occuperà dei rilasci di funzionalità minori
Valutazione del progetto (25 - 29 novembre 2019)
- Inviare un report sul progetto e la valutazione dei miei mentori
- Scrivere e inviare un resoconto della mia esperienza di partecipante alla stagione di Documenti.