На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- МикроПитон
- Технический писатель:
- Джоанна Нанжекье
- Название проекта:
- Документирование внутреннего устройства MicroPython
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Абстрактный
MicroPython — альтернативная реализация языка программирования Python. Он должен быть в основном совместим с Python 3.4, но имеет подмножество некоторых функций, особенно типов данных и модулей. MicroPython прост и эффективен для работы на микроконтроллерах и в средах с ограниченными ресурсами [1]. Проект имеет открытый исходный код и со временем привлек множество пользователей и участников. Документирование проекта будет способствовать росту числа пользователей, а также авторов новых функций. Участие в MicroPython обычно включает в себя работу над основной средой выполнения, портированием на новую плату/операционную систему или поддержку новой библиотеки. Это предложение сосредоточено на документации внутреннего устройства проекта MicroPython. Основными темами являются внутренняя работа самого интерпретатора, перенос языка на новую платформу и создание нового модуля.
Детали проекта
Целью проекта является добавление внутренней документации MicroPython к уже существующему docs.micropython.org. Мы также можем переместить это на Internals.micropython.org. Судя по отзывам сообщества, один из наставников Джим Массаред посоветовал нам перенести эту документацию в раздел «Разработка». Цель состоит в том, чтобы осветить детали MicroPython с точки зрения разработчика, работающего над реализацией самого MicroPython. Это приведет к плавной кривой вклада для всех, кто хочет принять участие в проекте.