Questa pagina è stata tradotta dall'API Cloud Translation.

Progetto VLC

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.

Riepilogo del progetto

Organizzazione open source:: VLC
Technical writer:: Avii
Nome progetto:: Crea la documentazione dell'utente di VLC per una porta per dispositivi mobili (Android)
Durata del progetto:: Durata standard (3 mesi)

Project description

SINTESI

La documentazione utente viene utilizzata come sistema di supporto statico per assistere gli utenti finali. Fornisce informazioni sia tecniche che non tecniche su un prodotto o servizio. Aiuta gli utenti a imparare a utilizzare il software o il servizio. Non tutti vogliono contattare l'assistenza o aspettare una risposta via email se hanno solo bisogno di indicazioni, consigli o espedienti. La documentazione utente serve proprio a questo. Riduce inoltre i costi di assistenza ed è un'identità dell'integrità del prodotto e del team di sviluppatori.

VLC per Android è stato scaricato oltre 100 milioni di volte solo dal Google Play Store. VLC offre molte funzionalità per le sue porte mobili, dalla riproduzione audio-video allo stream di rete. Spesso le persone desiderano utilizzare queste fantastiche funzionalità, ma non sono in grado di farlo. La ricerca di un blog o di un video casuale richiede molto tempo e pazienza, ma non si ottiene comunque l'autenticità delle informazioni ottenute. Attualmente, VLC ospita la documentazione utente di VLC per Android nella pagina wiki e fornisce una descrizione minore o nulla di queste funzionalità. Inoltre, l'ultimo aggiornamento delle pagine wiki è stato effettuato a marzo 2019. Il progetto attuale fornirà nuova documentazione per gli utenti con un design moderno e una maggiore facilità d'uso per la porta per Android.

SITUAZIONE ATTUALE

Le pagine wiki sono completamente obsolete e contengono molto meno informazioni sull'ultima versione di VLC. Inoltre, non sono facili da esplorare. Non è visibile un'opzione per leggere la documentazione in un'altra lingua oltre all'inglese. Non contiene alcuna descrizione delle caratteristiche.

ANALISI

-> La documentazione attuale è obsoleta e deve essere scritta in un modo nuovo, utilizzando una piattaforma e strumenti diversi.

-> La maggior parte degli utenti Android ha poca o nessuna conoscenza tecnica. Ci sono però persone che hanno bisogno di informazioni più tecniche su una funzionalità. Non è consigliabile scrivere e gestire due documenti separati per ciascuno dei suddetti scopi. Oppure, persino nella stessa documentazione che divide una caratteristica in base a dati tecnici e non tecnici crea ulteriore confusione. Poiché, ancora una volta, la maggior parte degli utenti è abituata all'interfaccia utente che vede o alle funzionalità che utilizza, non è facile per tutti decidere se qualcosa è tecnico o non tecnico. Vogliamo semplificare questa procedura.

-> La maggior parte degli utenti proverà a ottenere informazioni attraverso il proprio smartphone e si fermerà attraverso un computer desktop o altri dispositivi. Pertanto, la documentazione dovrebbe essere facilmente adattabile a ogni dimensione dello schermo. e non deve creare confusione in merito alla navigazione.

-> Non tutte le funzionalità della versione desktop sono disponibili nella porta Android e, se disponibili, non funzionano allo stesso modo in entrambe le porte. Ciò è dovuto al fatto che l'applicazione desktop è in fase di sviluppo da molto più tempo e ha raggiunto un tipo di saturazione, al contrario la porta per cellulari è relativamente nuova e ancora in fase di sviluppo. A parte questo, anche se oggigiorno i dispositivi mobili stanno diventando così potenti, esistono evidenti restrizioni sul tipo di funzionalità che possiamo incorporare principalmente a causa della domanda dell'utente finale. Avere una funzionalità che nessuno usa è uno spreco di risorse per lo sviluppo. Pertanto, non è consigliabile utilizzare entrambe le documentazioni sulla base delle caratteristiche.

IN BASE ALL'ANALISI SOPRA PREVISTA QUANTO SEGUE. 1. Al momento la documentazione per gli utenti di computer desktop utilizza il generatore di documenti Sphinx e il tema Lettura di documenti. L'utilizzo della stessa opzione per la porta Android ci aiuterà nei seguenti modi: -> Unione semplificata di entrambe le documentazioni. -> È ottimizzato per schermi di tutte le dimensioni. -> Esperienza fluida quando si accede alla documentazione utente di Android tramite la documentazione desktop

Separare capitoli, sezioni e sottosezioni in base alla loro posizione relativa nell'applicazione. Ad esempio - La modalità Background/PIP si trova in Altro -> Impostazioni->Video, quindi la struttura dei capitoli sarà

Altre

|__Impostazioni

| |__Raccolta multimediale

| |__Video -->Modalità Background/PIP

: -> Questo approccio migliorerà l'accesso perché gli utenti saranno in grado di raggiungere facilmente la parte in cui hanno bisogno di aiuto confrontandola con la posizione relativa nell'applicazione. Per ciascuna funzionalità possiamo separare ulteriormente la parte tecnica da quella non tecnica. Prima scriveremo una facile descrizione non tecnica, quindi evidenzieremo o etichetteremo ulteriormente le parti tecniche della stessa funzionalità, se presenti, subito sotto di essa. Questo potrebbe comportare delle ripetizioni, ma garantirà un'esperienza senza problemi della maggioranza non tecnica. Ciò sarà anche utile in futuro in futuro aumentando la manutenibilità. Poiché l'applicazione raggiungerà lo stato di saturazione, l'interfaccia utente relativa non cambierà molto, quindi in futuro, se una nuova funzionalità viene aggiunta/rimossa, possiamo semplicemente ridefinire la sezione. Se viene modificata l'intera interfaccia utente, possiamo riorganizzare le sezioni/i capitoli o ristrutturare l'intero documento. In ogni caso, dobbiamo modificare l'intera documentazione perché lo screenshot dovrà essere sostituito in modo che corrisponda all'interfaccia utente corrente. Una demo funzionante è ospitata qui : https://avinal.gitlab.io/vlc-android-docs/
Ogni sezione della documentazione consiste in uno screenshot etichettato , una descrizione della funzione, una parte più tecnica se pertinente e suggerimenti utili per la funzione.

-> Lo sviluppo indipendente di questa documentazione dell'utente dal desktop ci aiuterà a unire la documentazione in pochi passaggi senza influire sulla documentazione corrente o subire modifiche durante lo sviluppo. Propongo di inserire questa documentazione nella sezione Android della documentazione desktop dopo averla sviluppata, quindi di creare un permalink per la documentazione di VLC per Android.

-> Altri miglioramenti potrebbero includere la riprogettazione della pagina iniziale della documentazione per gli utenti di Google Desktop per consentire agli utenti di scegliere direttamente il sistema operativo preferito e reindirizzare alla documentazione del sistema operativo scelto. Poiché la documentazione per gli utenti di VLC per Windows, MacOS e Linux è già ben strutturata e conversa, potremmo mettere a disposizione varie opzioni tra cui scegliere tra Windows/MacOS/Linux o Android o iOS. Ciò darà luogo a una documentazione utente ben separata, ma unificata, con un solo link da utilizzare per tutte le porte.

PERCHÉ LA MIA DOCUMENTAZIONE DELL'UTENTE PROPOSTA È MIGLIORE? La documentazione per gli utenti proposta è strutturata sulla base dei pattern comuni seguiti dall'utente finale per richiedere assistenza. La documentazione combina tutte le funzionalità richieste, ad esempio semplicità, chiarezza, aspetto e design, conoscenze tecnologiche per massimizzare la facilità d'uso e l'esperienza dell'utente finale. Inoltre, è facile da gestire, poiché non è più necessario mantenere la documentazione dell'utente individuale per ogni porta.

PERCHÉ SONO LA PERSONA GIUSTA PER QUESTO PROGETTO? -> Scrivo codici da due anni e spesso ho bisogno di consultare la documentazione dell'API per alcune librerie o alcuni software o persino documentare il mio codice. Quindi so esattamente cosa le persone vogliono vedere nella documentazione, quali problemi devono affrontare e come affrontano la richiesta di assistenza. Potrò applicare la stessa esperienza per scrivere una documentazione coerente e facilmente leggibile.

-> Sto scrivendo attivamente materiale tecnico su Quora, Stack Overflow e varie altre piattaforme. So come spiegare le cose in modo accattivante e facile da capire.

-> VLC per Android è uno strumento potente e molto famoso, ma la maggior parte delle sue funzionalità è sconosciuta o non è disponibile alcun aiuto. Utilizzo VLC su piattaforme desktop e mobili da molti anni e so quali problemi può avere un utente. Grazie a tutte le mie conoscenze ed esperienza posso garantire un'ottima documentazione.