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:
- MicroPython
- Technischer Redakteur:
- Joannah Nanjekye
- Projektname:
- Interne Informationen von MicroPython
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Zusammenfassung
MicroPython ist eine alternative Implementierung der Programmiersprache Python. Es soll weitgehend mit Python 3.4 kompatibel sein, verfügt aber über einen Teil der Funktionen, insbesondere Datentypen und Module. MicroPython ist schlank und effizient und lässt sich auf Mikrocontrollern und ressourcenbeschränkten Umgebungen ausführen [1]. Das Projekt ist eine Open-Source-Software und hat im Laufe der Zeit viele Nutzende und Beitragende angezogen. Die Dokumentation des Projekts wird ein größeres Wachstum bei den Nutzenden fördern, aber auch einen Beitrag zu neuen Funktionen leisten. Ein Beitrag zu MicroPython erfordert in der Regel entweder die Arbeit an der Kernlaufzeit, die Portierung auf ein neues Board bzw. ein neues Betriebssystem oder die Wartung einer neuen Bibliothek. Dieser Vorschlag konzentriert sich auf die Dokumentation der internen Strukturen des MicroPython-Projekts. Die Hauptthemen sind die innere Funktionsweise des Dolmetschers, die Übertragung der Sprache auf eine neue Plattform und das Erstellen eines neuen Moduls.
Projektdetails
Das Projekt zielt darauf ab, die MicroPython-interne Dokumentation zu der bereits vorhandenen Datei docs.micropython.org hinzuzufügen. Wir können sie auch nach Internals.micropython.org verschieben. Aufgrund des Feedbacks der Community hat einer der Mentoren Jim Mussared empfohlen, diese Dokumentation in den Bereich „Entwickeln“ zu verschieben. Das Ziel ist es, MicroPython-Details aus der Perspektive von Entwicklern zu behandeln, die an der Implementierung von MicroPython selbst arbeiten. Dies führt zu einer sanften Beitragskurve für alle, die sich am Projekt beteiligen möchten.