このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- MicroPython
- テクニカル ライター:
- Joannah Nanjekye 氏
- プロジェクト名:
- MicroPython の内部を文書化する
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
抽象化
MicroPython は Python プログラミング言語の代替実装です。Python 3.4 とほぼ互換性を持つことを目的としていますが、一部の機能（特にデータ型とモジュール）を備えています。MicroPython は、マイクロコントローラやリソースの制約がある環境での実行に無駄がなく、効率的です [1]。このプロジェクトはオープンソースであり、これまで多くのユーザーや貢献者を魅了しています。プロジェクトを文書化することで、ユーザーだけでなく新機能の貢献者も増加させることができます。MicroPython への貢献には、通常、コアの実行時間、新しいボードやオペレーティング システムへの移植、新しいライブラリのメンテナンスのいずれかが含まれます。このプロポーザルでは、MicroPython プロジェクトの内部に関するドキュメントに重点を置いています。通訳者自体の内部動作、新しいプラットフォームへの言語の移植、新しいモジュールの作成が主なテーマとなっています。
プロジェクトの詳細
このプロジェクトは、すでに確立されている docs.micropython.org に MicroPython の内部ドキュメントを追加することを目的としています。これを internals.micropython.org に移動することもできます。メンターの 1 人である Jim Mussared 氏は、コミュニティからのフィードバックを受け、このドキュメントを「開発」セクションに移動するよう助言しました。MicroPython 自体の実装に取り組んでいるデベロッパーの視点から MicroPython の詳細を説明することを目標としています。これにより、プロジェクトへの参加を希望するすべてのユーザーにとっての貢献度が緩やかになります。