Diese Seite wurde von der Cloud Translation API übersetzt.

Arduino-Projekt

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:: Arduino
Technischer Redakteur:: AghaSaad04
Projektname:: Drittanbieterbibliotheken dokumentieren
Projektdauer:: Standarddauer (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 Forschungsarbeiten. In diesem Projekt werde ich alle Bibliotheken von Drittanbietern dokumentieren. Ich möchte die Bibliotheken dokumentieren, die von Arduino erstellt und beigesteuert werden, damit ihr ganzes Potenzial für die Entwickler enthüllt wird. Ich werde die folgenden Aufgaben ausführen:

Die Funktionsweise der Bibliothek dokumentieren Dokumentieren, wie die Bibliotheken verbessert werden können, damit sie den Anforderungen gerecht werden

Beispiel:

Die NESController-Bibliothek von Arduino muss wirklich gut dokumentiert sein. Die Funktionen, Kompatibilität, Beispiele und Anwendungen sollten der Dokumentation für Beitragende hinzugefügt werden. Die Nutzung ist bereits in der Dokumentation erwähnt, die weiter verbessert werden kann. Nbiot-arduino ist eine Arduino-Bibliothek für den Zugriff auf NBIoT-Module. Die Dokumentation kann durch Erweitern der Optionen für die Nutzung, Erstellung und Tests sowie für die Fehlerbehebung verbessert werden. Beispiele mit Code-Snippets sollten ebenfalls angegeben werden. Die am häufigsten markierte Bibliothek ArduinoJson ist als Beispiele für die Verwendung der Bibliothek in verschiedenen Stationen gut dokumentiert. Die Dokumentation enthält eine API-Referenz mit einer Beschreibung der einzelnen Klassen und Funktionen, häufig gestellte Fragen mit Antworten auf praktisch alle Fragen und den AduinoJson Assistant, der Programme für seine Nutzenden schreibt. Ebenso sollte eine detaillierte Dokumentation für alle Bibliotheken durchgeführt werden, deren Dokumentation verbessert und erweitert werden muss. Da ich Erfahrung im Internet der Dinge (IoT) habe, habe ich Grundkenntnisse über Mikrocontroller. Ich beherrsche verschiedene Programmiersprachen wie 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 bin sehr gespannt darauf, mehr zu lernen und meine Fähigkeiten und Kenntnisse zu erweitern.

Ich werde wegen seiner nutzerfreundlichen Syntax und seiner umfangreichen Funktionen Markdown für die Gestaltung aller meiner Texte verwenden.

Vorlage

Dies ist eine der Vorlagen, die für die Dokumentation verwendet werden können. Es kann geändert und neue Abschnitte entsprechend den Anforderungen des Dokuments 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 geben, aber im Falle eines Missverständnisses werde ich diese Stunden an den Wochenenden vergüten.Während der Gemeinschaftsphase werde ich die Kommunikationswege besprechen und wöchentliche Treffen, Mittel und Zeit für diese Treffen mit meinem Mentor abschließen. Ich werde meinen Mentor über meine Arbeit auf dem Laufenden halten und meine Arbeitsdetails per E-Mail an ihn weiterleiten. Ich bevorzuge den Team Viewer für die Kommunikation, da er einfach zu nutzen ist und viele Funktionen bietet, z. B. Bildschirmfreigaben usw.

Zukunftspläne

Meine Zukunftspläne sind nach der GSoD 2019 sehr klar. Ich werde auch in anderen Projekten zur Organisation beitragen. Ich werde versuchen, sie in allen Aspekten zu perfektionieren – von der Dokumentationsperspektive bis hin zur Sicherheitsperspektive. Ich werde sicher an jedem Meeting der Organisation teilnehmen, falls ich jemals eine Gelegenheit dazu bekomme.

Nutzungsbedingungen

Ich stimme feierlich zu, dass ich so arbeiten werde, wie ich oben erläutert habe, und für den Fall einer Fehlgeburt zur Rechenschaft gezogen bin. Ich weiß, wie viel Engagement für dieses Projekt erforderlich ist, und ich versichere Ihnen, dass ich meine ganze Saison in dieses Projekt einsetze, damit ich die beste Arbeit leisten kann.

Vielen Dank, dass Sie den gesamten Vorschlag gelesen haben. Bei weiteren Fragen kannst du dich jederzeit gern wieder an mich wenden.