Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- MicroPython
- Technical writer:
- Joannah Nanjekye
- Nome progetto:
- Documenta gli elementi interni di MicroPython
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Abstract
MicroPython è un'implementazione alternativa del linguaggio di programmazione Python. Il suo obiettivo è essere per lo più compatibile con Python 3.4, ma ha un sottoinsieme di alcune funzionalità, in particolare tipi di dati e moduli. MicroPython è snello ed efficiente per funzionare su microcontroller e ambienti con risorse limitate. [1] Il progetto è open source e nel tempo ha attirato molti utenti e collaboratori. Documentare il progetto promuoverà una maggiore crescita degli utenti, ma anche dei collaboratori di nuove funzionalità. Contribuire a MicroPython di solito comporta il lavoro sul tempo di esecuzione del core, il trasferimento su una nuova scheda/sistema operativo o il mantenimento di una nuova libreria. Questa proposta è incentrata sulla documentazione degli elementi interni del progetto MicroPython. I temi principali sono i meccanismi interni dell'interprete stesso, il trasferimento della lingua su una nuova piattaforma e la creazione di un nuovo modulo.
Dettagli dei progetti
Il progetto punta ad aggiungere la documentazione interna di MicroPython ai file docs.micropython.org già consolidati. Possiamo anche spostarlo in internals.micropython.org. In base ai feedback della community, uno dei mentori, Jim Mussared, ha consigliato di spostare questa documentazione nella sezione "Sviluppo". L'obiettivo è esaminare i dettagli di MicroPython dal punto di vista di uno sviluppatore, lavorando all'implementazione di MicroPython stesso. Ciò porterà a una leggera curva di contributi per chiunque voglia partecipare al progetto.