Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- OpenELIS Global
- Technical writer:
- Areesha
- Nome 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 per OpenELIS. I-TECH intende rivoluzionare il modo in cui gli utenti di OpenELIS ricevono assistenza in base alle loro esigenze specifiche del contesto. Attualmente, le istruzioni sull'utilizzo di OpenELIS sono contenute in un unico manuale dell'utente che gli utenti possono trovare noioso e lungo da consultare. Alcuni utenti, in particolare i nuovi, apprezzano l'accesso a una vasta gamma di materiali che possono sfogliare e imparare lungo il percorso. Gli altri utenti, in particolare quelli che hanno maggiore esperienza e familiarità con un prodotto digitale specifico come OpenELIS, vorranno individuare e utilizzare rapidamente una risorsa specifica per completare un'attività di inserimento dati o generazione di report. Le attività specifiche includeranno:
conversione del Manuale dell'utente esistente (non aggiornato) in una libreria completa e aggiornata di ausili professionali e tutorial scritti su tutte le funzionalità correnti (incluse le funzionalità più recenti, come la gestione dei test, la scansione dei codici a barre, l'immissione in batch e l'importazione dei risultati dell'analizzatore), compresi i tag di metadati per facilitare l'indicizzazione delle informazioni;
Sviluppare / aggiornare una versione inglese dei materiali di supporto
Fornisce agli utenti l'accesso a un elenco "Top 10" degli aiuti di ricerca a cui si accede più di frequente.
Creare una guida di stile e un documento sulle convenzioni di codifica