Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- CircuitVerse
- Technischer Redakteur:
- Pragati
- Projektname:
- Nutzerdokumentation und Leitfäden
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Nach einer eingehenden Analyse der Zielgruppe und der aktuell verfügbaren Nutzerdokumentation schlagen wir die folgenden Dokumentationsaufgaben vor:
1) Fügen Sie Videoanleitungen hinzu, um die beliebten Workflows zu demonstrieren und das Onboarding zu verbessern. In den Videos wird nur ein Konzept beschrieben. Videos geben eine Richtung vor, während diese Aktion auf dem Bildschirm ausgeführt wird.
Ein Beispiel für eine Videoanleitung zur Verwendung des Combinational Analysis Tools finden Sie hier: https://www.youtube.com/watch?v=7FkeqBYcd1w Hinweis 1: Dieses Video veranschaulicht, wie Anmerkungen verwendet werden können, um einen einheitlichen Videostil zu erstellen. Hinweis 2: Wenn ich mit der Arbeit für CircuitVerse beginne, erwerbe ich eine Lizenz für die Software. Das Endprodukt wird kein Wasserzeichen enthalten.
Empfohlene Themen für die Videotutorial-Workflows: - Erste Schritte mit CircuitVerse: In dieser Videoanleitung kannst du dir eine kurze Einführung zu CircuitVerse ansehen. -- Das Combinational Analysis Tool verwenden: In dieser Videoanleitung erfährst du, wie Schaltkreise mit Wahrheitstabellendaten erzeugt werden. --Bilder in hoher Auflösung exportieren: In dieser Videoanleitung erfahren Sie, wie Sie hochauflösende Bilder Ihrer Schaltkreise in verschiedene Formate exportieren. --Subschaltungen für ein strukturiertes Design verwenden: In dieser Videoanleitung erfahren Sie, wie Sie Teilschaltungen zur Vereinfachung der Struktur komplexer Schaltkreise erstellen. --Verwenden des Hex-Bin-Dec Convertor-Tool zur Konvertierung von Schaltungen: In dieser Video-Anleitung erfahren Sie, wie Sie das Hex-Bin-Dec-Convertor-Tool zum Konvertieren verwenden. --Zeitdiagramme von Schaltkreisen für einen bestimmten Schaltkreis visualisieren: In dieser Videoanleitung erfahren Sie, wie Nutzer Schaltpläne für einen bestimmten Schaltkreis visualisieren können.
Einige der Videoanleitungen können über Webseiten und in der Nutzerdokumentation miteinander verknüpft werden.
2) Erstelle eine Landingpage für das Tutorial, um einen kurzen Überblick über die CircuitVerse-Plattform zu geben und eine grafische Darstellung der verschiedenen Workflows bereitzustellen. Nutzer greifen auf die Landingpage der Circuitverse-GitHub-Website zu, auf der sie einen kurzen Überblick über die verschiedenen Anleitungen finden, die für unterschiedliche Inhalts-Workflows angeboten werden. So hat der Nutzer die Möglichkeit, sich verschiedene Anleitungen für seine Anforderungen anzusehen und auszuwählen. Unten sehen Sie ein Beispiel für die Seitenstruktur der Landingpage dieser Anleitung.
3) Erstellen Sie Schritt-für-Schritt-Anleitungen, um Nutzenden zu zeigen, wie sie das Tool verwenden können, um das Verhalten einfacher und komplexer Schaltkreise zu erlernen und zu analysieren. Lernen Sie das Tool, indem Sie mit dem Tool spielen. In Bezug auf die CircuitVerse-Projekte schlage ich vor, mindestens fünf Anleitungen für Anfänger und Fortgeschrittene hinzuzufügen, um das Onboarding zu verbessern. Jedes Tutorial zur Veranschaulichung eines vollständigen Workflows bietet eine Einführung in das Tutorial, gefolgt von einem Designprozess, Komponentenliste, Schritt-für-Schritt-Anleitungen und Übungsübungen. Bei komplexen Workflows decken Videos einen einzelnen Teil eines Gesamtkonzepts ab.
Unter diesem Link können Sie eine Beispielanleitung zum Erstellen eines Decoder für sieben Segmente aufrufen: https://pragatijain.github.io/circuitverse/index.html
Themen sind unter anderem: --Drehende LED-Displays bauen -- Funktionsweise einer Wellen-Carry-Adder kennenlernen --Teil 1A: 4-Bit-Größenvergleich analysieren - Teil 1B: Hexadezimalrechner erstellen -- Implementierung einer finite State Machine (FSM) analysieren
4) Überarbeiten Sie die Struktur der Seitenleistennavigation, um Einheitlichkeit, Lesbarkeit und Einheitlichkeit zu verbessern.
Projekttools 1) Camtasia für Video-Tutorials. Ich habe eine Testversion zum Erstellen des Beispielvideos verwendet. Wenn ich mit der Arbeit für CircuitVerse beginne, werde ich eine Lizenz für die Software erwerben, wobei das Endprodukt kein Wasserzeichen enthält. 2) Google-Dokumente zum Schreiben meiner Handbücher, die ich später in GitHub aktualisiere, um sie im CircuitVerse-Repository zu hosten. 3) Wiki-Markup und HTML zur Verwaltung meiner Inhalte in GitHub.
Zeitplan Vor dem 16. August Leisten Sie Beiträge für die Organisation auf GitHub.
Community-Bonding (17. August bis 13. September) Lege einen Kommunikationskanal und eine Uhrzeit fest (aufgrund von Zeitunterschieden). meine Ziele zu optimieren und Erwartungen auf beiden Seiten zu wecken. Erfahren Sie mehr über die Community und das Produkt. Besprechen Sie die vorgeschlagene Dokumentationsstruktur mit den beratenden Personen und anderen Mitgliedern der Organisation und legen Sie sie fest.
Dokumentationszeitraum Dieses Projekt folgt den Projektrichtlinien mit Standardlänge (insgesamt 11 Wochen, vom 14.09.2020 bis zum 30.11.2020). Ich werde ca. 20 Stunden pro Woche damit verbringen, die unten genannten Ziele zu erreichen. Zusätzlich zu diesen Zielen werde ich während dieser Zeit an Mentoring-Meetings teilnehmen und kommunizieren, falls erforderlich. Ich werde mit den beratenden Personen zusammenarbeiten, um den besten Zeitpunkt dafür zu bestimmen. Hinweis: Dieser Zeitplan ist flexibel und berücksichtigt, dass sich organisatorische Anforderungen ändern können. Die großen Zeitrahmen ermöglichen Flexibilität und die Möglichkeit, den Fokus nach Bedarf zu verlegen.
Woche 1: Identifizierte Meilensteine überprüfen und optimieren Fork CircuitVerse-Repository und auf meinen Computer herunterladen Mit Mentoren den Stil der Videos besprechen und eine Vorlage für den Videostartbildschirm, Füllmusik für Titel und Abspann sowie zusätzliche Informationen entwickeln, die enthalten sein sollten. Sehen Sie sich die Themen der Videoanleitung an und lassen Sie sie genehmigen. Sehen Sie sich Anleitungsthemen an und lassen Sie sie genehmigen. Navigationsstruktur der Seitenleiste überprüfen und genehmigen lassen
Woche 2: Anleitungsvorlage erstellen und vom Mentor genehmigen lassen Landingpage für Anleitung zum Hosten der Anleitungen erstellen
Woche 3, 4, 5: Videoanleitungen zur Veranschaulichung verschiedener Simulator-Workflows hinzufügen
Woche 6, 7, 8, 9: Anleitungen für verschiedene einfache und komplexe Schaltkreise erstellen
Woche 10: Navigationsleiste in der Seitenleiste neu strukturieren, um das Onboarding für Nutzer zu verbessern
Woche 11: Korrekturlesen meiner Arbeit auf Tippfehler und Fehler.
Relevante CircuitVerse-Arbeitsbeispiele
*Unter diesem Link finden Sie eine Beispielanleitung: Sieben Segment-Decoder erstellen. https://pragatijain.github.io/circuitverse/index.html
*Hier finden Sie einen Link zu einer Videoanleitung zur Verwendung des Combinational Analysis Tools: https://www.youtube.com/watch?v=7FkeqBYcd1w Hinweis 1: Dieses Video dient zwar als Beispiel für vorhandene Inhalte, soll aber zeigen, wie Anmerkungen verwendet werden können, um einen einheitlichen Videostil zu erstellen. Hinweis 2: Wenn ich mit der Arbeit für GDevelop beginne, werde ich eine Lizenz für die Software erwerben. Das Endprodukt wird kein Wasserzeichen enthalten.
*Landingpage für CircuitVerse-Tutorial https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*Vollständiges Angebot als Google-Dokument anzeigen: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
Beispielanleitungsvorlage: 7 Segment-Decoder 7 Segment-Decoder
Überblick:
In dieser Anleitung werden verschiedene Schritte zum Erstellen eines Decoders aus 7 Segmenten mithilfe von CircuitVerse beschrieben. Ein Decoder ist ein kombinierter Schaltkreis, der eine Binärzahl in die entsprechende Dezimalzahl umwandelt. Es nimmt vier Bits Eingaben und sieben Ausgaben an.
Entwicklungsverfahren
Um den 7-Segment-Schaltkreis in CircuitVerse zu erstellen, gehen wir wie folgt vor: Erstellen Sie die Wahrheitstabelle mithilfe des kombinationalen Analysetools, das im CircuitVerse-Simulator verfügbar ist. Mithilfe dieser Wahrheitstabelle generieren wir dann den Schaltkreis im Simulator. Dieser Schaltkreis steuert die Ausgabe auf ein siebenteiliges LED-Display. Verbinde die Labels des Kombinationskreislaufs mit den entsprechenden Ausgängen des siebenteiligen LED-Displays, um den Schaltkreis in Aktion zu sehen. Eine Sieben-Segment-Anzeige ist ein elektronisches Anzeigegerät zur Anzeige von Dezimalzahlen von 0 bis 9. Weitere Informationen Wahrheitstabelle In Tabelle 1 unten sind verschiedene Ausgaben für verschiedene Eingabekombinationen für einen Decoder aus 7 Segmenten aufgeführt.
Liste der CircuitVerse-Elemente
In Tabelle 2 sind die verschiedenen Komponenten aufgeführt, die für die Implementierung der Schaltung erforderlich sind.
Die Wahrheitstabelle formulieren
Führen Sie die folgenden Schritte aus, um die Wahrheitstabelle im CircuitVerse-Simulator zu erstellen:
Stromkreis vervollständigen
In Abbildung 10 werden die entsprechenden Eingangskabel für die Kennzeichnungen des Kombinationskreises mit den Ausgängen des Siebensegment-Displays verbunden, um den Schaltkreis fertigzustellen. Dieses Video zeigt eine im CircuitVerse-Simulator gebaute simulierte Decodierer-Strecke mit 7 Segmenten. Videolink: https://www.youtube.com/embed/tGTy4P-RxP0
Schaltkreis analysieren
Wechseln Sie zwischen verschiedenen Eingabewerten (S3, S2, S1, S0) und validieren Sie die Wahrheitstabelle (siehe Tabelle 1), um die implementierte Decoderr-Schaltkreis für sieben Segmente zu verifizieren.
Eine Displaykomponente mit sieben Segmenten umfasst acht LED-Segmente, bei denen ein Ende der Stifte aus dem Modul gezogen wird (siehe Abbildung 8). Damit eine LED eines bestimmten Segments leuchtet, müssen die relevanten Segmente (in Abbildung 10 mit a, b, c, d, e, f, g gekennzeichnet) eingeschaltet werden, sodass sie die Zahlen von 0 bis 9 darstellen. Damit beispielsweise die Zahl 1 angezeigt wird, müssen die LEDs b und c eingeschaltet sein.
Wenn die LED nicht die richtige Dezimalzahl anzeigt, sehen Sie sich die Tabelle 3 und Abbildung 10 an und beheben Sie die Kabelverbindungen. In Tabelle 3 ist die Konfiguration der Anzeige mit 7 Segmenten aufgeführt.