Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- Mautico
- Technical Writer:
- Preferisci Kelvin
- Nome del 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 condivise. Se utilizzata esternamente, una knowledge base è un luogo in cui gli utenti possono trovare tutto ciò che devono sapere sui prodotti o servizi, sull'organizzazione e sul settore di un'azienda. Una knowledge base interna, invece, viene in genere utilizzata per consentire alla community/agli utenti di collaborare e distribuire internamente tutte le conoscenze e le informazioni dell'azienda. Sebbene i contenuti di knowledge base specifiche varino in base a numerosi fattori, in genere includono informazioni su come iniziare a utilizzare prodotti specifici, sfruttare al meglio le funzionalità avanzate e superare problemi o difficoltà comuni. Il vantaggio principale della creazione e della presentazione di una knowledge base al tuo pubblico è che ti consente di fornire informazioni approfondite, istantanee e on demand e risposte ai membri del pubblico/utenti/community senza dover intervenire singolarmente.
La knowledge base di Mautic è un repository centrale per tutorial, guide illustrative e best practice su argomenti correlati a Mautic, direttamente (ad es. come fare le cose in Mautic) o indirettamente (ad es. strategie di marketing più generali).
Al momento della stesura di questo articolo, la knowledge base di Mautic è piuttosto recente e incompleta e la community di Mautic vuole utilizzare questo progetto per migliorare il suo modo di fornire informazioni approfondite e on demand alla documentazione per gli utenti, in modo da consentire agli utenti finali di avere un'esperienza ottimale durante l'utilizzo di Mautic. La knowledge base di Mautic era abbastanza informativa, ma servivano tutorial e guide aggiornati, nonché la creazione di nuovi tutorial, per adattarsi alla versione Mautic 3x.
Le mie prime impressioni dopo aver esaminato la documentazione esistente Al momento, la knowledge base di Mautic è disponibile all'indirizzo https://kb.mautic.org/. Alcuni tutorial, guide pratiche e argomenti sulle best practice nella documentazione non sono aggiornati, sono scarsi o incompleti e non coprono le informazioni sulla versione corrente di Mautic.
Perché il miglioramento che proponi è migliore di quello attuale/delle aree a cui mi piacerebbe dare il mio contributo? Il miglioramento proposto sarà quello di migliorare e garantire efficienza, coerenza e tranquillità a qualsiasi utente finale. Contiene tutorial scritti, guide pratiche e best practice, nonché le relative immagini associate, istruzioni e spiegazioni su come utilizzare ogni funzionalità di Mautic, aggiornate, facili da navigare e comprensibili.
Analisi
La knowledge base di Mautic è stata scritta nel CMS flat-file 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 pratiche in base alla versione Mautic 3x.
- Creare risorse per la knowledge base della community Mautic appena creata
- Scrivi una serie di tutorial e guide che aiutino gli utenti di Mautic a configurare e utilizzare l'applicazione in modo più efficace.
- Aggiorna il tutorial video in modo che si adatti alla versione Mautic 3x.
- Rimuovi le immagini e le informazioni obsolete.
- Riscrivere la knowledge base per renderla più comprensibile.
- Assicurati di implementare correttamente la guida di stile/il pattern della documentazione della knowledge base
Cronologia
Prima del 1° agosto
- Continua a dare contributi all'organizzazione.
- Acquisisci familiarità con la documentazione della knowledge base e con la versione corrente di Mautic.
- Acquisisci nuove tecniche e competenze di scrittura tecnica che ti saranno utili durante l'implementazione del progetto.
Rafforzamento della community (1° agosto - 1° settembre)
- Configurare un canale di comunicazione e un orario (a causa del fuso orario)
- Perfezionare i miei obiettivi e definire le aspettative su entrambi i lati
- Scopri di più sulla community e sul prodotto
- Discutere la struttura della documentazione proposta con i mentor e altri membri dell'organizzazione.
- Finalizza le funzionalità proposte e le altre modifiche che devono essere apportate alla documentazione esistente.
Periodo della documentazione
- Settimana 1 (2 settembre - 22 novembre)
- Durante questi periodi lavorerò direttamente con i miei mentor per :
- Esamina la knowledge base.
- Aggiorna i tutorial e le guide pratiche in base alla versione Mautic 3x.
- Creare risorse per la knowledge base della community Mautic appena creata
- Scrivi una serie di tutorial e guide che aiutino gli utenti di Mautic a configurare e utilizzare l'applicazione in modo più efficace.
- Aggiorna il tutorial video in modo che si adatti alla versione Mautic 3x.
- Rimuovi le immagini e le informazioni obsolete.
- Riscrivere la knowledge base per renderla più comprensibile.
- Assicurati di implementare correttamente le linee guida di stile/il pattern della documentazione della knowledge base.
- Prendere in considerazione la cadenza di rilascio, in quanto il team di sviluppo è molto impegnato con le release per funzionalità minori.
Valutazione del progetto (25-29 novembre 2019)
- Inviare un report sul progetto e la valutazione da parte dei miei mentor
- Scrivere e inviare un report sulla mia esperienza come partecipante alla Stagione di Documenti.