Progetto CircuitVerse

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

Riepilogo del progetto

Organizzazione open source:
CircuitVerse
Technical writer:
Pragati
Nome progetto:
Documentazione e guide per l'utente
Durata del progetto:
Durata standard (3 mesi)

Project description

Dopo aver svolto un'analisi approfondita del segmento di pubblico e della documentazione per gli utenti attualmente disponibile, propongo le seguenti attività relative alla documentazione:

1) Aggiungi tutorial video per dimostrare i flussi di lavoro popolari e migliorare l'esperienza di onboarding. I video delineano un singolo concetto. I video ti indicheranno le indicazioni mentre compi l'azione sullo schermo.

Qui puoi trovare un link al tutorial video di esempio per l'utilizzo dello strumento di analisi combinato: https://www.youtube.com/watch?v=7FkeqBYcd1w Nota 1: sebbene questo video sia un esempio di contenuti esistenti, ha lo scopo di mostrare lo stile dell'utilizzo delle annotazioni per creare uno stile coerente. Nota 2: quando inizio a lavorare per CircuitVerse, acquisterò una licenza per il software e il prodotto finale non includerà una filigrana.

Argomenti suggeriti per i flussi di lavoro dei tutorial video: --Introduzione a CircuitVerse: guarda questo tutorial video per un rapido tour di CircuitVerse --Utilizzo dello strumento di analisi combinata: guarda questo tutorial video per imparare a generare circuiti utilizzando i dati di una tabella di verità. --Esportazione di immagini ad alta risoluzione: guarda questo tutorial video per imparare a esportare immagini ad alta risoluzione dei tuoi circuiti in più formati --Using Subcircuits for Structured Design: Guarda questo tutorial video per imparare a creare sottocircuiti per semplificare la struttura di circuiti complessi --Utilizzo dello strumento di conversione Hex-Bin-Dec: guarda questo tutorial video per imparare a utilizzare lo strumento di progettazione di circuiti Hex-Bin-Dec per l'implementazione. --Visualizzazione dei diagrammi di temporizzazione del circuito per un determinato circuito: guarda questo tutorial video per imparare come gli utenti possono visualizzare i diagrammi di temporizzazione del circuito per un determinato circuito.

Alcuni dei tutorial video possono essere collegati tra loro nelle pagine web e nella documentazione dell'utente.

2) Crea una pagina di destinazione per il tutorial per fornire una breve panoramica della piattaforma CircuitVerse e una visualizzazione grafica dei vari flussi di lavoro. Gli utenti accederanno a una pagina di destinazione del tutorial sul sito GitHub di Circuitverse che fornirà una breve descrizione dei vari tutorial disponibili per i diversi flussi di lavoro dei contenuti. In questo modo l'utente ha la possibilità di visualizzare e scegliere tutorial diversi per le proprie esigenze. Di seguito è riportato un esempio approssimativo della struttura della pagina di destinazione del tutorial.

3) Crea tutorial passo passo per spiegare agli utenti come utilizzare lo strumento per apprendere e analizzare il comportamento di circuiti di base e complessi. Addestra lo strumento giocando con lo strumento. In riferimento ai progetti in primo piano di CircuitVerse, propongo di aggiungere almeno 5 tutorial per utenti di livello principiante e intermedio per migliorare l'esperienza di onboarding. Ogni tutorial illustra un flusso di lavoro completo e fornisce un'introduzione, seguita da una procedura di progettazione, un elenco dei componenti, istruzioni dettagliate ed esercitazioni. Nel caso di flussi di lavoro complessi, i video tratteranno una singola parte dell'idea generale.

Visita questo link per visualizzare un tutorial di esempio: Crea un decodificatore a sette segmenti: https://pragatijain.github.io/circuitverse/index.html

Alcuni degli argomenti includono: --Costruire un display LED rotante --Scoprire come funziona un sommatore di ripple --Parte 1A: Analizzare un comparatore di magnitudine a 4 bit --Parte 1B: Creare una calcolatrice esadecimale --Analizzare l'implementazione di una macchina a stati finiti (FSM)

4) Rivedere la struttura della barra di navigazione laterale per migliorare la coerenza, la leggibilità e la coesione.

Strumenti di progetto 1) Camtasia per i tutorial video. Ho utilizzato una versione di prova per realizzare il video di esempio. Quando inizio a lavorare per CircuitVerse, acquisterò una licenza per il software e il prodotto finale non includerà una filigrana. 2) Documenti Google per scrivere le mie guide che in seguito aggiornerò in GitHub per ospitarle nel repository di CircuitVerse. 3) Markup Wiki e HTML per gestire i miei contenuti in GitHub.

Sequenza temporale Prima del 16 agosto Contribuisci all'organizzazione su GitHub.

Community bonding (17 agosto - 13 settembre) Imposta un canale di comunicazione e un orario (a causa della differenza di tempo). Perfeziona i miei obiettivi e definisci le aspettative da entrambi i lati. Scopri di più sulla community e sul prodotto. Discuti e finalizza la struttura di documentazione proposta con i mentori e altri membri dell'organizzazione.

Periodo di documentazione Questo progetto seguirà le linee guida del progetto di lunghezza standard (11 settimane in totale, dal 14/9/2020 al 30/11/2020). Dedica circa 20 ore alla settimana al raggiungimento degli obiettivi descritti di seguito. Oltre a questi obiettivi, parteciperò a riunioni e comunicazioni con i mentori durante questo periodo, se necessario. Collaborerò con i mentori per stabilire il momento migliore per farlo. Nota: questa tempistica è flessibile e riconosce il fatto che le esigenze dell'organizzazione possono cambiare. Gli ampi periodi di tempo consentono flessibilità e la possibilità di cambiare obiettivo in base alle esigenze.

Settimana 1: Esamina i traguardi individuati e perfezionali Il repository di Fork CircuitVerse e scaricalo sul mio computer Discuti con i mentori sullo stile dei video e sviluppa un modello di schermata di apertura del video, eventuali musica di riempimento per il titolo e le schermate finali e informazioni aggiuntive che dovrebbero essere incluse. Esamina gli argomenti dei tutorial video e ottieni l'approvazione. Identifica gli argomenti dei tutorial e ottieni l'approvazione. Esamina la struttura di navigazione della barra laterale e ottieni l'approvazione

Settimana 2: Crea un modello di tutorial e ricevi l'approvazione del mentore Crea la pagina di destinazione del tutorial per ospitare i tutorial

Settimana 3, 4 e 5: aggiungere tutorial video per dimostrare i diversi flussi di lavoro del simulatore

Settimana 6, 7, 8, 9: crea tutorial per diversi circuiti semplici e complessi

Settimana 10: ristruttura la barra di navigazione della barra laterale per renderla coerente al fine di migliorare l'esperienza di onboarding degli utenti

Settimana 11: Correggi il mio lavoro per errori di battitura ed errori.

Esempi di lavori di CircuitVerse pertinenti

*Visita questo link per visualizzare un tutorial di esempio: Creazione di un decodificatore a sette segmenti. https://pragatijain.github.io/circuitverse/index.html

*Qui puoi trovare un link al tutorial video di esempio per l'utilizzo dello strumento di analisi combinato: https://www.youtube.com/watch?v=7FkeqBYcd1w Nota 1: anche se questo video è un esempio di contenuti esistenti, ha lo scopo di mostrare come utilizzare le annotazioni per creare uno stile coerente. Nota 2: quando inizio a lavorare per GDevelop, acquisterò una licenza per il software e il prodotto finale non includerà una filigrana.

*Pagina di destinazione del tutorial su CircuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#

*Visualizza la proposta completa come documento Google: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#

Esempio di modello di tutorial: decodificatore a 7 segmenti Decodificatore a 7 segmenti

Panoramica:

Questo tutorial illustra diversi passaggi per la creazione di un decodificatore a 7 segmenti utilizzando CircuitVerse. Un decoder è un circuito combinato che converte un numero binario nel corrispondente numero decimale. Prevede quattro bit di input e ha sette output.

Procedura di progettazione

Per generare il circuito di visualizzazione a 7 segmenti in CircuitVerse, seguiamo i passaggi riportati di seguito: Usa lo strumento di analisi combinato disponibile nel simulatore di CircuitVerse per formulare la tabella di verità. Utilizzando questa tabella di verità, genereremo il circuito all'interno del simulatore. Questo circuito indirizzerà l'uscita a un display LED a sette segmenti. Collega le rispettive etichette del circuito combinato alle rispettive uscite del display LED a sette segmenti per vedere il nostro circuito in azione. Un display a sette segmenti è un dispositivo di visualizzazione elettronico che consente di visualizzare numeri decimali da 0 a 9.Consulta Analizza il comportamento del circuito utilizzando i dati della tabella di verità. Tabella 1 riportata di seguito elenca diversi output per diverse combinazioni di input per un decoder a 7 segmenti.

Elenco degli elementi di CircuitVerse

Nella tabella 2 sono elencati i diversi componenti necessari per l'implementazione del circuito.

Formula la tavola della verità

Segui i passaggi riportati di seguito per formulare la tabella di verità nel simulatore CircuitVerse:

Completa il circuito

Fare riferimento alla Figura 10 per collegare i rispettivi fili di ingresso per le etichette corrispondenti del circuito combinato alle rispettive uscite del display a sette segmenti per completare il circuito. Questo video mostra un circuito simulato del decodificatore a 7 segmenti creato nel simulatore di CircuitVerse. Link al video: https://www.youtube.com/embed/tGTy4P-RxP0

Analizza il circuito

Attivare diversi valori di ingresso (S3, S2, S1, S0) e convalidare la tabella di verità (fare riferimento alla Tabella 1) per verificare il circuito di decodifica a sette segmenti implementato.

Un componente di visualizzazione a sette segmenti ha 8 segmenti LED al suo interno e un'estremità dei piedini estratta dal modulo, come mostrato nella Figura 8. Per far brillare un LED di un particolare segmento, è necessario accendere i segmenti rilevanti (etichettati come a, b, c, d, e, f, g nella Figura 10) per rappresentare i numeri da 0 a 9. Ad esempio, per visualizzare il numero 1, i LED b e c devono essere accesi.

Se il LED non visualizza il numero decimale corretto, fare riferimento alla Tabella 3 e alla Figura 10 e risolvere i problemi relativi ai collegamenti del cablaggio. La tabella 3 elenca la configurazione dei pin della visualizzazione a 7 segmenti.