Projet CircuitVerse

Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.

Résumé du projet

Organisation Open Source:
CircuitVerse
Rédacteur technique:
Pragati
Nom du projet:
Documentation et guides utilisateur
Durée du projet:
Durée standard (3 mois)

Project description

Après avoir analysé en profondeur l'audience et la documentation utilisateur actuellement disponible, je propose les tâches suivantes:

1) Ajoutez des tutoriels vidéo pour présenter les flux de travail populaires et améliorer l'expérience d'intégration. Les vidéos décrivent un seul concept. Les vidéos guident l'utilisateur lors de l'exécution de cette action à l'écran.

Vous trouverez ici un exemple de tutoriel vidéo sur l'utilisation de l'outil d'analyse combinée. https://www.youtube.com/watch?v=7FkeqBYcd1w Remarque 1: Bien que cette vidéo illustre du contenu existant, elle a pour but de montrer comment les annotations peuvent être utilisées pour créer un style vidéo cohérent. Remarque 2: Lorsque je commence à travailler pour CircuitVerse, j'achète une licence pour le logiciel et le produit final n'inclura pas de filigrane.

Sujets suggérés pour les workflows de ce tutoriel vidéo : --Premiers pas avec CircuitVerse: Regardez ce tutoriel vidéo pour une visite rapide de CircuitVerse. --Utilisation de l'outil d'analyse combinatoire: regardez ce tutoriel vidéo pour apprendre à générer des circuits à l'aide des données d'une table de vérité. --Exporter des images en haute résolution: regardez ce tutoriel vidéo pour apprendre à exporter des images haute résolution de vos circuits dans plusieurs formats. --Utilisation de sous-circuits pour la conception structurée: regardez ce tutoriel vidéo pour apprendre à créer des sous-circuits afin de simplifier la structure de circuits complexes. - Utilisation de l'outil de conversion de type Hex-Bin-Dec: regardez ce tutoriel vidéo pour apprendre à utiliser les circuits hexadécimaux et les outils de conversion. --Visualiser les diagrammes de temporisation d'un circuit donné: regardez ce tutoriel vidéo pour apprendre comment les utilisateurs peuvent visualiser les diagrammes de temporisation d'un circuit donné.

Certains tutoriels vidéo peuvent être reliés entre les pages Web et la documentation utilisateur.

2) Créez une page de destination de tutoriel pour donner un bref aperçu de la plate-forme CircuitVerse et fournir une vue graphique des différents flux de travail. Les utilisateurs accéderont à une page de destination de tutoriel sur le site GitHub de Circuitverse, qui fournira un bref aperçu des différents tutoriels proposés pour les différents flux de travail de contenu. Cela permet à l'utilisateur de visualiser et de choisir différents tutoriels selon ses besoins. Vous trouverez ci-dessous un exemple de structure de page de la page de destination du tutoriel.

3) Créez des tutoriels détaillés pour expliquer aux utilisateurs comment utiliser l'outil afin d'apprendre et d'analyser le comportement des circuits basiques et complexes. Apprendre à utiliser l'outil en jouant. En ce qui concerne les projets présentés sur CircuitVerse, je propose d'ajouter au moins cinq tutoriels pour les utilisateurs de niveaux débutant et intermédiaire afin d'améliorer l'expérience d'intégration. Chaque tutoriel illustre un flux de travail complet, suivi d'un processus de conception, d'une liste de composants, d'instructions détaillées et d'exercices pratiques. Pour les flux de travail complexes, les vidéos couvrent une partie individuelle d'un concept global.

Cliquez sur ce lien pour voir un exemple de tutoriel: Créer un décodeur à sept segments: https://pragatijain.github.io/circuitverse/index.html

Voici quelques-uns des sujets abordés : --Créer un écran LED roulant --Découvrir le fonctionnement d'un additionneur d'ondulations --Partie 1A: Analyser un comparateur de magnitude 4 bits --Partie 1B: Création d'un calculateur hexadécimal --Analyser l'implémentation d'une machine à états fin (FSM)

4) Revoyez la structure de la barre de navigation latérale pour améliorer la cohérence, la lisibilité et la cohérence.

Outils de projet 1) Camtasia pour les tutoriels vidéo J'ai utilisé une version d'essai pour réaliser cet extrait vidéo. Lorsque je commencerai à travailler pour CircuitVerse, j'achèterai une licence pour le logiciel et le produit final n'inclura pas de filigrane. 2) Google Docs pour écrire mes guides que je mettrai à jour plus tard dans GitHub pour les héberger dans le dépôt CircuitVerse. 3) Un balisage Wiki et du code HTML pour gérer mon contenu sur GitHub.

Calendrier Avant le 16 août Apportez des contributions à l'organisation sur GitHub.

Engagement communautaire (17 août – 13 septembre) Définissez un canal de communication et un horaire (en raison du décalage horaire). Affiner mes objectifs et définir des attentes des deux côtés. En savoir plus sur la communauté et le produit. Discuter et finaliser la structure de documentation proposée avec les mentors et les autres membres de l'organisation.

Période de documentation Ce projet doit respecter les directives relatives à la durée standard (11 semaines au total, du 14/09/2020 au 30/11/2020). Je consacrerai environ 20 heures par semaine à atteindre les objectifs décrits ci-dessous. En plus de ces objectifs, je participerai à des réunions de mentorat et je participerai à la communication au cours de cette période, si nécessaire. Je vais travailler avec les mentors afin de déterminer le meilleur moment pour cela. Remarque: Cette chronologie est flexible et tient compte de l'évolution des besoins organisationnels. Les délais importants offrent une certaine flexibilité et permettent de changer d'objectif si nécessaire.

Semaine 1 : Passez en revue les jalons identifiés et affinez-les Fork CircuitVerse référentiel et téléchargez-le sur mon ordinateur Discutez avec les mentors du style des vidéos, et développez un modèle d'écran d'ouverture de vidéo, toute musique de remplissage pour le titre et les écrans de fin, ainsi que les informations supplémentaires à inclure. Passez en revue les sujets des tutoriels vidéo et faites-les approuver Identifiez les sujets des tutoriels vidéo et faites-les approuver. Examiner la structure de navigation de la barre latérale et la faire approuver

Semaine 2 : Créer un modèle de tutoriel et le faire approuver par le mentor Créer une page de destination pour les tutoriels

Semaines 3, 4 et 5: ajoutez des tutoriels vidéo pour présenter les différents flux de travail des simulateurs

Semaines 6, 7, 8, 9: Créer des tutoriels pour différents circuits simples et complexes

Semaine 10: Restructurer la barre latérale de navigation pour plus de cohérence et améliorer l'expérience d'intégration des utilisateurs

Semaine 11: Relire mon travail à la recherche de fautes de frappe et d'erreurs.

Exemples de tâches CircuitVerse pertinentes

*Consultez un exemple de didacticiel sur ce lien : "Créer un décodeur à sept segments". : https://pragatijain.github.io/circuitverse/index.html

*Un exemple de tutoriel vidéo expliquant comment utiliser l'outil d'analyse combinée est disponible ici. https://www.youtube.com/watch?v=7FkeqBYcd1w Remarque 1: Bien que cette vidéo illustre du contenu existant, elle a pour but de montrer comment les annotations peuvent être utilisées pour créer un style vidéo cohérent. Remarque 2: Lorsque je commence à travailler pour GDevelop, j'achète une licence pour le logiciel et le produit final ne comporte pas de filigrane.

*Page de destination du tutoriel CircuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#

*Consultez la proposition complète sous forme de document Google: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#

Exemple de modèle de tutoriel: 7 décodeur de segments 7 décodeur de segments

Présentation :

Ce tutoriel vous présente les différentes étapes de la création d'un décodeur à sept segments à l'aide de CircuitVerse. Un décodeur est un circuit combinatoire qui convertit un nombre binaire en nombre décimal correspondant. Il prend quatre bits d'entrée et a sept sorties.

Procédure de conception

Pour générer le circuit d'affichage à sept segments dans CircuitVerse, nous allons suivre les étapes ci-dessous : utiliser l'outil Combinational Analysis disponible dans le simulateur CircuitVerse pour formuler la table de vérité. À l'aide de cette table de vérité, nous allons générer le circuit dans le simulateur. Ce circuit générera une sortie vers un écran LED à sept segments. Reliez les étiquettes respectives du circuit combiné aux sorties respectives de l'écran LED à sept segments pour voir notre circuit en action. Un affichage à sept segments est un dispositif d'affichage électronique permettant d'afficher des nombres décimaux de 0 à 9.Reportez-vous à l'analyse du comportement du circuit à l'aide des données de la table de vérité. Tableau de vérité Le tableau 1 ci-dessous liste différentes sorties pour différentes combinaisons d'entrées pour un décodeur à sept segments.

Liste des éléments de CircuitVerse

Le tableau 2 liste les différents composants requis pour la mise en œuvre du circuit.

Formuler la table de vérité

Suivez les étapes ci-dessous pour formuler la table de vérité dans le simulateur CircuitVerse:

Compléter le circuit

Reportez-vous à la figure 10 pour connecter les fils d'entrée respectifs des étiquettes correspondantes du circuit combiné aux sorties respectives de l'écran à sept segments afin de compléter le circuit. Cette vidéo présente un circuit simulé d'un décodeur à 7 segments construit dans le simulateur CircuitVerse. Lien de la vidéo: https://www.youtube.com/embed/tGTy4P-RxP0

Analyser le circuit

Basculez les différentes valeurs d'entrée (S3, S2, S1, S0) et validez la table de vérité (voir le tableau 1) pour vérifier le circuit décodeur à sept segments implémenté.

Un composant d'affichage à sept segments comporte huit segments de LED et une extrémité de leurs broches est retirée du module, comme illustré dans la figure 8. Pour que la LED d'un segment particulier s'allume, les segments concernés (identifiés comme a, b, c, d, e, f, g sur la figure 10) doivent être sous tension pour représenter les nombres de 0 à 9. Par exemple, pour l'affichage numéro 1, les voyants LED b et c doivent être sous tension.

Si le voyant LED n'affiche pas le bon nombre décimal, reportez-vous aux tableaux 3 et Figure 10 pour résoudre les problèmes de câblage. Le tableau 3 présente la configuration d'un repère d'affichage en sept segments.