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:
- CircuitVerse
- Redattore tecnico:
- Pragati
- Nome del progetto:
- Documentazione e guide per gli utenti
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Dopo aver effettuato un'analisi approfondita del pubblico e dell'attuale documentazione utente disponibile, ti propongo le seguenti attività relative alla documentazione:
1) Aggiungi tutorial video per dimostrare i flussi di lavoro più comuni e migliorare l'esperienza di onboarding. I video descrivono un singolo concetto. I video ti daranno un'indicazione durante lo svolgimento dell'azione sullo schermo.
Qui puoi trovare un link di esempio al tutorial video sull'utilizzo dello strumento di analisi combinatoria: https://www.youtube.com/watch?v=7FkeqBYcd1w Nota 1: anche se questo video è un esempio di contenuti esistenti, ha lo scopo di mostrare lo stile di come le annotazioni possono essere utilizzate per creare uno stile di video 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 breve tour di CircuitVerse --Utilizzo dello strumento di analisi combinatoria: guarda questo tutorial video per scoprire come generare circuiti utilizzando i dati della tabella di verità. --Esportazione di immagini ad alta risoluzione: guarda questo video tutorial per scoprire come esportare immagini ad alta risoluzione dei tuoi circuiti in più formati --Utilizzo di sottocircuiti per la progettazione strutturata: guarda questo video tutorial per scoprire come creare sottocircuiti per semplificare la struttura di circuiti complessi --Utilizzo dello strumento Hex-Bin-Dec Convertor: guarda questo video tutorial per scoprire come utilizzare lo strumento Hex-Bin-Dec Convertor per la progettazione e l'implementazione di circuiti. Visualizzazione dei diagrammi di temporizzazione del circuito per un determinato circuito: guarda questo tutorial video per scoprire come gli utenti possono visualizzare i diagrammi di temporizzazione del circuito per un determinato circuito.
Alcuni dei tutorial video possono essere collegati tra le pagine web e la documentazione per gli utenti.
2) Crea una pagina di destinazione di un tutorial per fornire una breve panoramica della piattaforma CircuitVerse e fornire una visione grafica dei vari flussi di lavoro. Gli utenti accederanno alla pagina di destinazione di un tutorial sul sito di Circuitverse GitHub che fornirà una breve descrizione dei vari tutorial offerti per i vari flussi di lavoro dei contenuti. In questo modo l'utente può visualizzare e scegliere diversi tutorial in base alle proprie esigenze. Di seguito è riportato un esempio approssimativo della struttura della pagina di destinazione del tutorial.
3) Crea tutorial passo passo per insegnare agli utenti come utilizzare lo strumento per apprendere e analizzare il comportamento di circuiti di base e complessi. Insegna allo 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. Illustrando un flusso di lavoro completo, ogni tutorial fornirà un'introduzione, seguita da una procedura di progettazione, un elenco di componenti, istruzioni passo passo ed esercizi pratici. Per i flussi di lavoro complessi, i video copriranno una singola parte di un concetto generale.
Visita questo link per visualizzare un tutorial di esempio: crea un decodificatore a sette segmenti: https://pragatijain.github.io/circuitverse/index.html
Ecco alcuni degli argomenti trattati: --Creare un display LED scorrevole --Esplorare il funzionamento di un sommatore con riporto alternato --Parte 1A: analizzare un comparatore di grandezza a 4 bit --Parte 1B: creare un calcolatore esadecimale --Analisi di un'implementazione di una macchina a stati finiti (FSM)
4) Rivedi la struttura della barra laterale per migliorare la coerenza, la leggibilità e l'armonia.
Strumenti di progetto 1) Camtasia per i tutorial video. Ho utilizzato una versione di prova per realizzare il video di esempio. Quando inizierò a lavorare per CircuitVerse, acquisirò una licenza per il software e il prodotto finale non includerà una filigrana. 2) Documenti Google per la stesura delle mie guide, che aggiornerò in seguito in GitHub per ospitarle nel repository CircuitVerse. 3) Markup di Wiki e HTML per gestire i miei contenuti su GitHub.
Tempistiche Prima del 16 agosto Fornisci contributi all'organizzazione su GitHub.
Legame con la community (17 agosto - 13 settembre) Imposta un canale di comunicazione e un orario (a causa del diverso orario). Perfezionare i miei obiettivi e definire le aspettative su entrambi i lati. Scopri di più sulla community e sul prodotto. Discuti e finalizza la struttura della documentazione proposta con i mentor e gli altri membri dell'organizzazione.
Periodo della documentazione Questo progetto seguirà le linee guida del progetto di lunghezza standard (11 settimane in totale, dal 14/9/2020 al 30/11/2020). Dedicherò circa 20 ore a settimana al completamento degli obiettivi descritti di seguito. Oltre a questi obiettivi, parteciperò alle riunioni con il mentore e alle comunicazioni durante questo periodo, se necessario. Collaborerò con i mentori per stabilire il momento migliore per questa presentazione. Nota: questa tempistica è flessibile e tiene conto del fatto che le esigenze dell'organizzazione possono cambiare. I lunghi periodi di tempo consentono flessibilità e la possibilità di cambiare argomento, se necessario.
Settimana 1: Esamina i traguardi identificati e perfezionali Esegui il fork del repository CircuitVerse e scaricalo sul mio computer Discutere con i mentori dello stile dei video, nonché sviluppare un modello di schermata di apertura del video, eventuali tracce musicali per le schermate del titolo e di chiusura e informazioni aggiuntive da includere. Esamina gli argomenti dei tutorial video e falli approvare Identifica gli argomenti dei tutorial e falli approvare. Rivedi la struttura di navigazione della barra laterale e ottieni l'approvazione
Seconda settimana: crea il modello di tutorial e ottieni l'approvazione del mentore crea la pagina di destinazione del tutorial per ospitare i tutorial
Settimane 3, 4 e 5: aggiungi tutorial video per dimostrare diversi flussi di lavoro del simulatore
Settimane 6, 7, 8, 9: crea tutorial per diversi circuiti semplici e complessi
Settimana 10: ristruttura la navigazione della barra laterale per garantire coerenza e migliorare l'esperienza di onboarding dell'utente
Settimana 11: correggere i miei lavori per individuare errori ortografici e altri errori.
Esempi di lavori di CircuitVerse pertinenti
*Visita questo link per visualizzare un tutorial di esempio: crea un decodificatore a sette segmenti. : https://pragatijain.github.io/circuitverse/index.html
*Qui puoi trovare un esempio di link a un tutorial video sull'utilizzo dello strumento di analisi combinata: https://www.youtube.com/watch?v=7FkeqBYcd1w Nota 1: anche se questo video è un esempio di contenuti esistenti, ha lo scopo di mostrare lo stile di come le annotazioni possono essere utilizzate per creare uno stile di video coerente. Nota 2: quando inizierò a lavorare per GDevelop, acquisirò una licenza per il software e il prodotto finale non includerà una filigrana.
*Pagina di destinazione del tutorial di 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#
Modello di tutorial di esempio: decodificatore a 7 segmenti Decodificatore a 7 segmenti
Panoramica:
Questo tutorial illustra diversi passaggi per creare un decodificatore a 7 segmenti utilizzando CircuitVerse. Un decodificatore è un circuito combinatorio che converte un numero binario nel numero decimale corrispondente. Riceve quattro bit di input e ha sette uscite.
Procedura di progettazione
Per generare il circuito del display a sette segmenti in CircuitVerse, segui i passaggi riportati di seguito: Utilizza lo strumento di analisi combinatoria disponibile nel simulatore CircuitVerse per formulare la tabella di verità. Utilizzando questa tabella di verità genereremo il circuito all'interno del simulatore. Questo circuito invierà l'output a un display LED a sette segmenti. Collega le rispettive etichette del circuito combinatorio 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 per la visualizzazione di numeri decimali da 0 a 9.Consulta Analizza il comportamento del circuito utilizzando i dati della tabella di verità. Tabella di verità La tabella 1 seguente elenca diversi output per diverse combinazioni di input per un decodificatore a 7 segmenti.
Elenco degli elementi di CircuitVerse
La tabella 2 elenca i diversi componenti necessari per l'implementazione del circuito.
Formula la tabella di verità
Per formulare la tabella di verità nel simulatore di CircuitVerse:
Completa il circuito
Per completare il circuito, fai riferimento alla Figura 10 per collegare i rispettivi cavi di input per le etichette corrispondenti del circuito combinatorio ai rispettivi output del display a sette segmenti. Questo video mostra un circuito simulato del decodificatore a 7 segmenti costruito all'interno del simulatore CircuitVerse. Link video: https://www.youtube.com/embed/tGTy4P-RxP0
Analizza il circuito
Attiva/disattiva diversi valori di input (S3, S2, S1, S0) e convalida la tabella di verità (consulta la Tabella 1) per verificare il circuito del decodificatore a sette segmenti implementato.
Un componente del display a sette segmenti contiene 8 segmenti LED e ha un'estremità dei pin estratti dal modulo, come mostrato nella Figura 8. Per fare in modo che un LED di un determinato segmento si accenda, i segmenti pertinenti (etichettati come a, b, c, d, e, f, g nella Figura 10) devono essere attivati 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, consulta la Tabella 3 e la Figura 10 e risolvi i problemi di connessione del cablaggio. La tabella 3 elenca la configurazione dei pin del display a 7 segmenti.