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:
- MicroPython
- Technischer Redakteur:
- Joannah Nanjekye
- Projektname:
- Interne Funktionen von MicroPython dokumentieren
- Projektlänge:
- Standardlänge (3 Monate)
Projektbeschreibung
Zusammenfassung
MicroPython ist eine alternative Implementierung der Programmiersprache Python. Es soll größtenteils mit Python 3.4 kompatibel sein, bietet aber nur einen Teil der Funktionen, insbesondere Datentypen und Module. MicroPython ist schlank und effizient und kann auf Mikrocontrollern und in ressourcenbeschränkten Umgebungen ausgeführt werden [1]. Das Projekt ist Open Source und hat im Laufe der Zeit viele Nutzer und Mitwirkende angezogen. Wenn Sie das Projekt dokumentieren, steigt nicht nur die Anzahl der Nutzer, sondern auch die der Mitwirkenden an neuen Funktionen. Wenn Sie zu MicroPython beitragen möchten, arbeiten Sie in der Regel entweder an der Kernlaufzeit, führen einen Portierungsvorgang auf ein neues Board/Betriebssystem durch oder verwalten eine neue Bibliothek. Dieser Vorschlag konzentriert sich auf die Dokumentation der internen Strukturen des MicroPython-Projekts. Die Hauptthemen waren die interne Funktionsweise des Interpreters selbst, die Portierung der Sprache auf eine neue Plattform und die Erstellung eines neuen Moduls.
Projektdetails
Ziel dieses Projekts ist es, die interne Dokumentation von MicroPython in die bestehende Dokumentation unter docs.micropython.org aufzunehmen. Wir können das auch zu internals.micropython.org verschieben. Aufgrund des Feedbacks der Community, einer der Mentoren, hat Jim Mussared geraten, diese Dokumentation in einen Bereich für die Entwicklung zu verschieben. Ziel ist es, MicroPython-Details aus der Perspektive eines Entwicklers zu behandeln, der an der Implementierung von MicroPython selbst arbeitet. Dies führt zu einer sanften Beitragskurve für alle, die sich am Projekt beteiligen möchten.