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:
- Arduino
- Technischer Redakteur:
- AghaSaad04
- Projektname:
- Drittanbieterbibliotheken dokumentieren
- Projektdauer:
- Standardlaufzeit (3 Monate)
Projektbeschreibung
Ich bin ein erfahrener technischer Redakteur. Ich schreibe seit mehr als drei Jahren hochwertige Softwaredokumentationen, Benutzerhandbücher, Handbücher, Algorithmusanalysen, Projektdokumentationen und Forschungsberichte. In diesem Projekt dokumentiere ich alle Drittanbieterbibliotheken. Ich möchte die Arduino-Bibliotheken dokumentieren, um ihr ganzes Potenzial den Entwicklern offenzulegen. Ich werde die folgenden Aufgaben erledigen:
Die Funktionsweise der Bibliothek dokumentieren Dokumentieren, wie die Bibliotheken im Hinblick auf die Anforderungen verbessert werden können
Beispiel:
Die NESController-Bibliothek von Arduino muss gut dokumentiert sein. Die Funktionen, die Kompatibilität, Beispiele und Anwendungen sollten in der Dokumentation für die Mitwirkenden hinzugefügt werden. Die Nutzung wird bereits in der Dokumentation erwähnt, was noch verbessert werden kann. Nbiot-arduino ist eine Arduino-Bibliothek für den Zugriff auf NBIoT-Module. Die Dokumentation kann durch eine Erweiterung der Optionen „Verwendung“, „Erstellen und testen“ und „Fehlerbehebung“ verbessert werden. Beispiele mit Code-Snippets sollten ebenfalls enthalten sein. Die am häufigsten mit Sternen bewertete Arduino-Bibliothek ArduinoJson ist gut dokumentiert. Die Dokumentation enthält Beispiele zur Verwendung der Bibliothek in verschiedenen Stationen, eine API-Referenz mit der Beschreibung jeder Klasse und Funktion, FAQs mit Antworten auf nahezu alle Fragen und den ArduinoJson Assistant, der Programme für die Nutzer schreibt. Ebenso sollte eine ausführliche Dokumentation für alle Bibliotheken erstellt werden, deren Dokumentation verbessert und erweitert werden muss. Da ich Erfahrung im Bereich Internet der Dinge (IoT) habe, verfüge ich über grundlegendes Wissen zu Mikrocontrollern. Ich bin mit verschiedenen Programmiersprachen vertraut, darunter Python, Java, C, C++, HTML5, JavaScript und C#. Ich bin sehr interessiert und bereit, durch meine technischen Schreibfähigkeiten und mein Wissen über Elektronik, Mikrocontroller und Programmierung zu Arduino beizutragen. Ich möchte mehr lernen und meine Fähigkeiten und mein Wissen erweitern.
Ich werde Markdown für das Formatieren aller meiner Texte verwenden, da es eine nutzerfreundliche Syntax und umfangreiche Funktionen bietet.
Vorlage
Dies ist eine der Vorlagen, die für die Dokumentation verwendet werden können. Sie kann entsprechend den Anforderungen des Dokuments geändert und neue Abschnitte hinzugefügt werden.
$projectName/Library Name
--------
In this section, I will give background information of the library,
what does this library use, on what languages and framework it is based on,
what are the dependencies of this library/project where it will be used
Features
--------
I will add features of the project here like
- this library creates connection between server and client
- Make things faster
Installation
------------
In this section I will add the installation procedure and dependencies that
needs to be installed.
Install $project by running:
install project
Contribute
----------
For the contributors, I will add this section in documentation.
- Issue Tracker: github.com/$project/$project/issues
- Source Code: github.com/$project/$project
Support
-------
This section can also be added
If you are having issues, please let us know.
We have a mailing list located at: project@google-groups.com
License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.
Zeitaufwand und Kommunikation
Ich werde mehr als 45 Stunden pro Woche arbeiten, aber im Falle eines Missgeschicks werde ich diese Stunden am Wochenende kompensieren.Während des Community Bond-Zeitraums werde ich die Kommunikationsmittel besprechen und wöchentliche Besprechungen, Mittel und Zeiten für diese Besprechungen mit meinem Mentor abschließen. Ich halte meinen Mentor über meine Arbeit auf dem Laufenden und teile meine Arbeitsdetails per E-Mail an ihn. Ich bevorzuge Team Viewer für die Kommunikation, da es einfach zu bedienen ist und viele Funktionen wie die Bildschirmfreigabe bietet.
Zukunftspläne
Meine Zukunftspläne sind nach GSoD ’19 sehr klar. Ich werde auch in anderen Projekten für die Organisation tätig sein. Ich werde versuchen, es in allen Aspekten zu optimieren, sowohl in Bezug auf die Dokumentation als auch auf die Sicherheit. Ich werde auf jeden Fall an allen Treffen der Organisation teilnehmen, wenn ich die Gelegenheit dazu habe.
Nutzungsbedingungen
Ich erkläre hiermit feierlich, dass ich die oben beschriebenen Verfahren einhalten werde und im Falle einer Fehlgeburt zur Rechenschaft gezogen werde. Ich verstehe, dass für dieses Projekt viel Einsatz erforderlich ist. Ich versichere Ihnen, dass ich mich die ganze Saison über für dieses Projekt einsetzen werde, damit ich meine beste Arbeit abliefern kann.
Vielen Dank, dass Sie sich die Zeit genommen haben, den gesamten Vorschlag zu lesen. Bei weiteren Fragen kannst du dich jederzeit gern wieder an mich wenden.