Cette page contient les détails d'un projet de rédaction technique accepté pour la saison des documents Google.
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 (trois mois)
Project description
Après avoir effectué une analyse approfondie de l'audience et de la documentation utilisateur actuellement disponible, je propose les tâches de documentation ci-dessous:
1) Ajoutez des tutoriels vidéo pour présenter les workflows populaires et améliorer l'expérience d'intégration. Les vidéos présentent un seul concept. Les vidéos vous indiquent comment effectuer cette action à l'écran.
Un exemple de tutoriel vidéo sur l'utilisation de l'outil d'analyse combinée est disponible ici : https://www. youtube.com/watch?v=7FkeqBYcd1w.Remarque 1 : Bien que cette vidéo illustre le contenu existant, elle a pour but de montrer le style d'utilisation des annotations pour créer un style vidéo cohérent. Remarque 2: Lorsque je commencerai à travailler pour CircuitVerse, j'achèterai une licence pour le logiciel et le produit final n'inclura pas de filigrane.
Sujets suggérés pour les workflows des tutoriels vidéo : --Premiers pas avec CircuitVerse: regardez ce tutoriel vidéo pour découvrir CircuitVerse rapidement. --Utiliser l'outil d'analyse combinatoire: regardez ce tutoriel vidéo pour apprendre à générer des circuits à l'aide de données de table de vérité. --Exporter des images haute résolution: regardez ce tutoriel vidéo pour découvrir comment exporter des images haute résolution de vos circuits dans plusieurs formats. --Utiliser des sous-circuits pour la conception structurée: regardez ce tutoriel vidéo pour découvrir comment créer des sous-circuits afin de simplifier la structure de circuits complexes. --Utiliser l'outil de conversion hexadécimal-binaire-décimal: regardez ce tutoriel vidéo pour découvrir comment utiliser l'outil de conversion hexadécimal-binaire-décimal pour la conception et l'implémentation de circuits. --Visualiser les diagrammes de temporisation d'un circuit donné: regardez ce tutoriel vidéo pour découvrir comment les utilisateurs peuvent visualiser les diagrammes de temporisation d'un circuit donné.
Certains des tutoriels vidéo peuvent être interlié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 workflows. 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 différents workflows de contenu. L'utilisateur peut ainsi afficher et choisir différents tutoriels en fonction de ses besoins. Vous trouverez ci-dessous un exemple approximatif de la structure de la page de destination du tutoriel.
3) Créez des tutoriels détaillés pour expliquer aux utilisateurs comment utiliser l'outil pour apprendre et analyser le comportement de circuits simples et complexes. Enseignez l'outil en le faisant jouer avec. En ce qui concerne les projets mis en avant sur CircuitVerse, je propose d'ajouter au moins cinq tutoriels pour les utilisateurs débutants et intermédiaires afin d'améliorer l'expérience de découverte. Illustrant un workflow complet, chaque tutoriel commence par une introduction, suivie d'un processus de conception, d'une liste de composants, d'instructions détaillées et d'exercices pratiques. Pour les workflows complexes, les vidéos couvrent une partie spécifique d'un concept global.
Pour consulter un exemple de tutoriel, accédez à ce lien: Créer un décodeur à sept segments: https://pragatijain.github.io/circuitverse/index.html
Voici quelques-uns des sujets abordés : --Créer un affichage à LED défilant --Explorer le fonctionnement d'un additionneur à propagation de carry --Partie 1A: Analyser un comparateur de magnitude à 4 bits --Partie 1B: Créer une calculatrice hexadécimale --Analyser une implémentation de machine à états finis (FSM)
4) Révisez la structure de la navigation dans la barre latérale pour améliorer la cohérence, la lisibilité et la cohésion.
Outils de projet 1) Camtasia pour les tutoriels vidéo. J'ai utilisé une version d'essai pour créer l'exemple 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 rédiger mes guides, que je mettrai à jour ultérieurement sur GitHub pour les héberger dans le dépôt CircuitVerse. 3) Le balisage Wiki et le code HTML pour gérer mes contenus dans GitHub.
Calendrier Avant le 16 août Contribuez à l'organisation sur GitHub.
Liens avec la communauté (du 17 août au 13 septembre) Mettez en place un canal de communication et un délai (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 suivra les consignes de durée standard (11 semaines au total, du 14/09/2020 au 30/11/2020). Je vais consacrer environ 20 heures par semaine à la réalisation des objectifs décrits ci-dessous. En plus de ces objectifs, je participerai aux réunions de mentorat et à la communication pendant cette période, si nécessaire. Je vais travailler avec les mentors pour déterminer le meilleur moment pour cela. Remarque: Ce calendrier est flexible et tient compte du fait que les besoins des organisations peuvent changer. Ce délai permet de bénéficier d'une certaine flexibilité et de la possibilité de changer d'orientation si nécessaire.
Semaine 1 : Examiner les jalons identifiés et les affiner Forker le dépôt CircuitVerse et le télécharger sur mon ordinateur Discuter avec les mentors du style des vidéos, ainsi que développer un modèle d'écran d'ouverture de vidéo, toute musique de remplissage pour les écrans de titre et de fin, et les informations supplémentaires à inclure. Vérifiez les sujets des tutoriels vidéo et faites-les approuver. Examinez la structure de navigation de la barre latérale et faites-la approuver
Semaine 2 : Créez un modèle de tutoriel et faites-le approuver par le mentor. Créez une page de destination pour héberger les tutoriels.
Semaines 3, 4 et 5: Ajoutez des tutoriels vidéo pour illustrer différents workflows de simulateur
Semaines 6, 7, 8 et 9: Créer des tutoriels pour différents circuits simples et complexes
Semaine 10: Restructurer la navigation dans la barre latérale pour assurer la cohérence et améliorer l'intégration des utilisateurs
Semaine 11: Relire mon travail pour détecter les fautes de frappe et les erreurs.
Exemples de travaux CircuitVerse pertinents
*Cliquez sur ce lien pour consulter un exemple de tutoriel: Créer un décodeur à sept segments. : https://pragatijain.github.io/circuitverse/index.html
*Un exemple de lien vers un tutoriel vidéo sur l'utilisation de l'outil d'analyse combinée est disponible ici : https://www. youtube.com/watch?v=7FkeqBYcd1w.Remarque 1 : Bien que cette vidéo illustre des contenus existants, elle montre comment utiliser des annotations pour créer un style vidéo cohérent. Remarque 2: Lorsque je commencerai à travailler pour GDevelop, j'achèterai une licence pour le logiciel et le produit final n'inclura pas de filigrane.
*Page de destination du tutoriel CircuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*Afficher la proposition complète sous forme de document Google: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
Exemple de modèle de tutoriel: décodeur à sept segments
Présentation :
Ce tutoriel vous explique les différentes étapes de 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 reçoit quatre bits d'entrée et sept sorties.
Procédure de conception
Pour générer le circuit d'affichage à sept segments dans CircuitVerse, suivez les étapes ci-dessous : Utilisez l'outil d'analyse combinée disponible dans le simulateur CircuitVerse pour formuler la table de vérité. À l'aide de cette table de vérité, nous allons ensuite générer le circuit dans le simulateur. Ce circuit alimente la sortie d'un affichage à LED à sept segments. Connectez les libellés respectifs du circuit combinatoire 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 les chiffres décimaux de 0 à 9.Consultez la section "Analyser le comportement du circuit à l'aide des données de la table de vérité". Le tableau de vérité 1 ci-dessous présente différentes sorties pour différentes combinaisons d'entrées pour un décodeur à 7 segments.
Liste des éléments CircuitVerse
Le tableau 2 liste les différents composants nécessaires à la mise en œuvre du circuit.
Formuler la table de vérité
Pour formuler la table de vérité dans le simulateur CircuitVerse, procédez comme suit:
Compléter le circuit
Reportez-vous à la figure 10 pour connecter les fils d'entrée correspondants aux libellés correspondants du circuit combinatoire aux sorties respectives de l'afficheur à sept segments afin de compléter le circuit. Cette vidéo présente un circuit simulé de décodeur à sept segments intégré au simulateur CircuitVerse. Lien de la vidéo: https://www.youtube.com/embed/tGTy4P-RxP0
Analyser le circuit
Basculez 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 de décodeur à sept segments implémenté.
Un composant d'affichage à sept segments contient huit segments de LED, dont une extrémité des 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 (étiquetés a, b, c, d, e, f et g dans la figure 10) doivent être alimentés pour représenter les chiffres de 0 à 9. Par exemple, pour afficher le chiffre 1, les LED b et c doivent être alimentées.
Si le voyant n'affiche pas le bon nombre décimal, consultez le tableau 3 et la figure 10, puis vérifiez vos connexions de câblage. Le tableau 3 présente la configuration des broches de l'écran à sept segments.