Progetto OpenELIS Global

Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.

Riepilogo progetto

Organizzazione open source:
OpenELIS Global
Redattore tecnico:
Areesha
Nome del progetto:
Documentazione di OpenELIS per gli utenti finali
Durata del progetto:
Durata standard (3 mesi)

Project description

Cerchiamo di riprogettare e migliorare la documentazione rivolta agli utenti di OpenELIS. I-TECH intende rivoluzionare il modo in cui gli utenti di OpenELIS ricevono assistenza in base alle loro esigenze specifiche del contesto. Al momento, le istruzioni per l'utilizzo di OpenELIS sono contenute in un unico manuale dell'utente che può risultare noioso e richiedere molto tempo per la navigazione. Alcuni utenti, in particolare i nuovi, apprezzano di avere accesso a una vasta gamma di materiali che possono sfogliare e da cui imparare. Altri utenti, in particolare quelli più esperti e che hanno familiarità con un prodotto digitale specifico come OpenELIS, vorranno individuare e utilizzare rapidamente una risorsa specifica per completare un'attività di inserimento di dati o generazione di report. Le attività specifiche includeranno:

  • Conversione del manuale dell'utente esistente (obsoleto) in una raccolta completa e aggiornata di guide di lavoro e tutorial scritti su tutte le funzionalità attuali (incluse quelle più recenti, come la gestione dei test, la scansione dei codici a barre, l'inserimento collettivo e l'importazione dei risultati dell'analizzatore), inclusi i tag metadati per facilitare l'indicizzazione delle informazioni.

  • Sviluppare / aggiornare una versione in inglese dei materiali di assistenza

  • Fornire agli utenti l'accesso a un elenco dei "10 più cercati" degli aiuti per i lavori a cui accedono più di frequente.

  • Crea una guida di stile e un documento sulle convenzioni di programmazione