Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- CircuitVerse
- Technischer Redakteur:
- Pragati
- Projektname:
- Nutzerdokumentation und -leitfäden
- Projektdauer:
- Standardlaufzeit (3 Monate)
Projektbeschreibung
Nach einer ausführlichen Analyse der Zielgruppe und der derzeit verfügbaren Nutzerdokumentation schlage ich die folgenden Dokumentationsaufgaben vor:
1) Fügen Sie Videoanleitungen hinzu, um die beliebten Workflows zu demonstrieren und das Onboarding zu verbessern. Die Videos sollen ein einzelnes Konzept umreißen. Videos geben eine Richtung vor, während diese Aktion auf dem Bildschirm ausgeführt wird.
Hier findest du eine Videoanleitung zur Verwendung des Kombinationsanalysetools: https://www.youtube.com/watch?v=7FkeqBYcd1w Hinweis 1: Dieses Video zeigt zwar vorhandene Inhalte, soll aber veranschaulichen, wie Anmerkungen verwendet werden können, um einen einheitlichen Videostil zu schaffen. Hinweis 2: Wenn ich für CircuitVerse arbeite, kaufe ich eine Lizenz für die Software und das Endprodukt enthält kein Wasserzeichen.
Vorgeschlagene Themen für die Videoanleitungen: --Einstieg in CircuitVerse: In dieser Videoanleitung erhalten Sie einen kurzen Überblick über CircuitVerse. --Kombinatorische Analysetool verwenden: In dieser Videoanleitung erfahren Sie, wie Sie Schaltungen mithilfe von Wahrheitstabellendaten generieren. --Exportieren von Bildern in hoher Auflösung: In dieser Videoanleitung erfahren Sie, wie Sie Bilder in hoher Auflösung Ihrer Schaltungen in mehreren Formaten exportieren. --Unterschaltungen für strukturiertes Design verwenden: In dieser Videoanleitung erfahren Sie, wie Sie Unterschaltungen erstellen, um die Struktur komplexer Schaltungen zu vereinfachen. --Hex-Bin-Dec-Konverter-Tool verwenden: In dieser Videoanleitung erfahren Sie, wie Sie das Hex-Bin-Dec-Konverter-Tool für das Schaltungsdesign und die Implementierung verwenden. --Visualisierung von Schaltungszeitdiagrammen für eine bestimmte Schaltung: In dieser Videoanleitung erfahren Sie, wie Nutzer Schaltungszeitdiagramme für eine bestimmte Schaltung visualisieren können.
Einige der Videoanleitungen können über Webseiten und Nutzerdokumentation verlinkt werden.
2) Erstellen Sie eine Landingpage mit einer Anleitung, die einen kurzen Überblick über die CircuitVerse-Plattform bietet und eine grafische Darstellung der verschiedenen Workflows enthält. Nutzer rufen eine Anleitungs-Landingpage auf der GitHub-Website von Circuitverse auf, auf der die verschiedenen Anleitungen für verschiedene Inhaltsworkflows kurz beschrieben werden. So haben Nutzer die Möglichkeit, sich verschiedene Anleitungen anzusehen und je nach Bedarf auszuwählen. Unten sehen Sie ein grobes Beispiel für die Seitenstruktur der Landingpage der Anleitung.
3) Erstellen Sie Schritt-für-Schritt-Anleitungen, um Nutzern zu zeigen, wie sie mit dem Tool das Verhalten einfacher und komplexer Schaltungen lernen und analysieren können. Lernen Sie das Tool kennen, indem Sie damit spielen. In Bezug auf die von CircuitVerse vorgestellten Projekte empfehle ich, mindestens 5 Tutorials für Anfänger und Fortgeschrittene hinzuzufügen, um das Onboarding zu verbessern. Jedes Tutorial veranschaulicht einen vollständigen Workflow. Es beginnt mit einer Einführung, gefolgt von einem Designprozess, einer Komponentenliste, einer detaillierten Anleitung und Übungsaufgaben. Bei komplexen Workflows behandeln Videos einen einzelnen Teil eines Gesamtkonzepts.
Unter diesem Link finden Sie eine Beispielanleitung: Sieben Segment-Decoder erstellen: https://pragatijain.github.io/circuitverse/index.html
Zu den Themen gehören: --Ein LED-Laufband erstellen --Funktionsweise eines Ripple-Carry-Adders kennenlernen --Teil 1A: 4‑Bit-Magnitudenvergleicher analysieren --Teil 1B: Hexadezimalrechner erstellen --Implementierung eines FSM (Finite State Machine) analysieren
4) Die Struktur der Navigationsleiste überarbeiten, um für Einheitlichkeit, Lesbarkeit und Kohäsion zu sorgen.
Projekttools 1) Camtasia für Videoanleitungen Ich habe zum Erstellen des Beispielvideos eine Testversion verwendet. Wenn ich für CircuitVerse arbeite, kaufe ich eine Lizenz für die Software und das Endprodukt enthält kein Wasserzeichen. 2) Google Docs zum Erstellen meiner Anleitungen, die ich später in GitHub aktualisiere, um sie im CircuitVerse-Repository zu hosten. 3) Wiki-Markup und HTML zum Verwalten meiner Inhalte in GitHub
Zeitplan Vor dem 16. August Trage Beiträge zur Organisation auf GitHub bei.
Bindung der Community (17. August bis 13. September) Richten Sie aufgrund eines Zeitunterschieds einen Kommunikationskanal und eine Uhrzeit ein. Meine Ziele verfeinern und Erwartungen auf beiden Seiten formulieren. Erfahren Sie mehr über die Community und das Produkt. Besprechen und finalisieren Sie die vorgeschlagene Dokumentationsstruktur mit den Mentoren und anderen Mitgliedern der Organisation.
Dokumentationszeitraum Für dieses Projekt gelten die Richtlinien für Projekte mit Standardlänge (insgesamt 11 Wochen, vom 14. September 2020 bis zum 30. November 2020). Ich werde etwa 20 Stunden pro Woche für die unten aufgeführten Ziele aufwenden. Zusätzlich zu diesen Zielen werde ich in dieser Zeit nach Bedarf an Mentoring-Meetings und -Kommunikation teilnehmen. Ich werde mit den Mentoren den besten Zeitpunkt dafür bestimmen. Hinweis: Dieser Zeitplan ist flexibel und berücksichtigt, dass sich die Anforderungen von Organisationen ändern können. Die langen Zeiträume ermöglichen Flexibilität und die Möglichkeit, den Fokus nach Bedarf zu ändern.
Woche 1: Festgelegte Meilensteine überprüfen und optimieren CircuitVerse-Repository forken und auf meinen Computer herunterladen Mit Mentoren den Stil für Videos besprechen sowie eine Vorlage für den Video-Startbildschirm, beliebige Füllmusik für den Titel- und Endbildschirm sowie zusätzliche Informationen entwickeln, die enthalten sein sollten. Sehen Sie sich die Themen der Videoanleitungen an und lassen Sie sie genehmigen. Identifizieren Sie die Anleitungsthemen und lassen Sie sie genehmigen. Struktur der seitlichen Navigationsleiste prüfen und genehmigen lassen
Woche 2: Vorlage für das Tutorial erstellen und vom Mentor genehmigen lassen Landingpage für das Tutorial erstellen
Woche 3, 4, 5: Videoanleitungen hinzufügen, um verschiedene Simulator-Workflows zu demonstrieren
Woche 6, 7, 8, 9: Anleitungen für verschiedene einfache und komplexe Schaltungen erstellen
Woche 10: Die Navigationsleiste umstrukturieren, um für Einheitlichkeit zu sorgen und die Nutzereinrichtung zu verbessern
Woche 11: Meine Arbeit auf Tippfehler und Fehler prüfen.
Relevante Arbeitsproben für CircuitVerse
*Hier finden Sie ein Beispiel für eine Anleitung: Sieben Segment-Decoder erstellen. : https://pragatijain.github.io/circuitverse/index.html
*Hier findest du eine Videoanleitung zur Verwendung des Kombinationsanalysetools: https://www.youtube.com/watch?v=7FkeqBYcd1w Hinweis 1: Dieses Video zeigt zwar vorhandene Inhalte, soll aber veranschaulichen, wie Anmerkungen verwendet werden können, um einen einheitlichen Videostil zu schaffen. Hinweis 2: Wenn ich mit der Arbeit für GDevelop beginne, kaufe ich eine Lizenz für die Software und das Endprodukt enthält kein Wasserzeichen.
*CircuitVerse-Anleitung – Landingpage https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*Vollständigen Vorschlag als Google-Dokument ansehen: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
Beispiel für eine Anleitungsvorlage: 7-Segment-Decoder 7-Segment-Decoder
Überblick:
In diesem Tutorial erfahren Sie, wie Sie mit CircuitVerse einen Sieben-Segment-Decoder erstellen. Ein Decoder ist eine Kombinationsschaltung, die eine Binärzahl in die entsprechende Dezimalzahl umwandelt. Er benötigt vier Bits Eingabe und hat sieben Ausgaben.
Designverfahren
Zum Generieren der Anzeigeschaltung mit 7 Segmenten in CircuitVerse führen wir die folgenden Schritte aus: Verwende das im CircuitVerse-Simulator verfügbare Kombianalysetool, um die Wahrheitstabelle zu erstellen. Mithilfe dieser Wahrheitstabelle generieren wir dann den Schaltkreis innerhalb des Simulators. Diese Schaltung steuert die Ausgabe an ein Sieben-Segment-LED-Display. Verbinden Sie die entsprechenden Labels der kombinatorischen Schaltung mit den entsprechenden Ausgängen des Sieben-Segment-LED-Displays, um die Schaltung in Aktion zu sehen. Ein Sieben-Segment-Display ist ein elektronisches Anzeigegerät zur Anzeige von Dezimalzahlen von 0 bis 9.Analysieren Sie das Schaltungsverhalten anhand der Daten in der Wahrheitstabelle. Wahrheitstabelle Tabelle 1 unten enthält verschiedene Ausgaben für verschiedene Kombinationen von Eingaben für einen Sieben-Segment-Decoder.
Liste der CircuitVerse-Elemente
In Tabelle 2 sind die verschiedenen Komponenten aufgeführt, die für die Implementierung der Schaltung erforderlich sind.
Wahrheitstabelle formulieren
So formulieren Sie die Wahrheitstabelle im CircuitVerse-Simulator:
Schaltung vervollständigen
Verbinden Sie die entsprechenden Eingabedrähte für die entsprechenden Labels der kombinatorischen Schaltung mit den entsprechenden Ausgängen des Sieben-Segment-Displays, um die Schaltung zu vervollständigen (siehe Abbildung 10). In diesem Video wird eine simulierte Schaltung eines Sieben-Segment-Decoders im CircuitVerse-Simulator gezeigt. Videolink: https://www.youtube.com/embed/tGTy4P-RxP0
Schaltung analysieren
Stellen Sie verschiedene Eingabewerte (S3, S2, S1, S0) ein und validieren Sie die Wahrheitstabelle (siehe Tabelle 1), um die implementierte Sieben-Segment-Decoderschaltung zu überprüfen.
Eine Display-Komponente mit sieben Segmenten hat acht LED-Segmente und ein Ende der Pins ist aus dem Modul herausgezogen (siehe Abbildung 8). Damit eine LED eines bestimmten Segments leuchten kann, müssen relevante Segmente (in Abbildung 10 mit a, b, c, d, e, f und g gekennzeichnet) eingeschaltet sein, damit die Zahlen von 0 bis 9 dargestellt werden. Wenn beispielsweise die Zahl 1 angezeigt werden soll, müssen die LEDs b und c eingeschaltet sein.
Wenn die LED nicht die richtige Dezimalzahl anzeigt, lesen Sie die Informationen in Tabelle 3 und Abbildung 10 und beheben Sie die Verkabelungsprobleme. In Tabelle 3 ist die Konfiguration der PIN für die Anzeige mit 7 Segmenten aufgeführt.