このページには、Google シーズンの Google ドキュメントで承認されたテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- Arduino
- テクニカル ライター:
- AghaSaad04
- プロジェクト名:
- サードパーティ ライブラリを文書化する
- プロジェクトの期間:
- 標準の長さ（3 か月）
プロジェクトの説明
経験豊富なテクニカル ライターです。3 年以上にわたり、質の高いソフトウェア ドキュメント、ユーザーガイド、マニュアル、アルゴリズム分析、プロジェクト ドキュメント、研究論文を執筆してきました。 このプロジェクトでは、すべてのサードパーティ ライブラリを文書化します。私は、Arduino で開発され、貢献したライブラリを文書化し、そのすべての可能性をデベロッパーに向けて引き出すことを目指しています。以下のタスクを実施します。
ライブラリの動作を文書化 必要なニーズを満たすようにライブラリを改善する方法を文書化する
例
Arduino の NESController ライブラリについては、詳細なドキュメントが必要です。機能、互換性、例、アプリケーションは、コントリビューター向けドキュメントに追加する必要があります。使用方法はドキュメントですでに説明されていますが、これをさらに改善できます。Nbiot-arduino は、NBIoT モジュールにアクセスするための Arduino ライブラリです。使用方法、ビルドとテスト、デバッグのオプションを拡張することで、ドキュメントを改善できます。コード スニペットを含む例も含める必要があります。 Arduino で最も注目度の高いライブラリである ArduinoJson は、さまざまなステーションでのライブラリの使用方法を示す例、各クラスと関数の説明を含む API リファレンス、ほぼすべての質問に回答する FAQ、ユーザー向けのプログラムを作成する AduinoJson Assistant がドキュメントに記載されています。同様に、ドキュメントの改善と拡張が必要なすべてのライブラリについて、詳細なドキュメントを作成する必要があります。モノのインターネット（IoT）分野での経験があり、マイクロコントローラに関する基本的な知識は持っています。Python、Java、C、C++、HTML5、JavaScript、C# など、さまざまなプログラミング言語に習熟しています。Arduino のテクニカル ライティング スキルと、電子機器、マイクロコントローラ、プログラミングに関する知識を活かして、Arduino に貢献したいと思っています。もっと学び、スキルと知識を向上させたいと思っています。
使いやすい構文と豊富な機能を備えた Markdown を、すべての文章のスタイル設定に使用します。
テンプレート
これは、ドキュメントに使用できるテンプレートの 1 つです。ドキュメントの要件に応じて、変更や新しいセクションの追加が可能です。
$projectName/Library Name
--------
In this section, I will give background information of the library,
what does this library use, on what languages and framework it is based on,
what are the dependencies of this library/project where it will be used
Features
--------
I will add features of the project here like
- this library creates connection between server and client
- Make things faster
Installation
------------
In this section I will add the installation procedure and dependencies that
needs to be installed.
Install $project by running:
install project
Contribute
----------
For the contributors, I will add this section in documentation.
- Issue Tracker: github.com/$project/$project/issues
- Source Code: github.com/$project/$project
Support
-------
This section can also be added
If you are having issues, please let us know.
We have a mailing list located at: project@google-groups.com
License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.
時間の確保とコミュニケーション
週に 45 時間以上の勤務時間を確保しますが、万が一問題が発生した場合には、その時間を週末に補います。コミュニティの絆を深める期間に、コミュニケーション手段について話し合い、メンターとの毎週のミーティング、手段、時間を決定します。メンターに私の仕事に関する最新情報を知らせ、メールを通じて私のメンターに仕事の詳細を共有します。チーム閲覧者は共有画面などの多くの機能で使いやすいので、コミュニケーションにはチーム閲覧者をおすすめします。
今後の計画
GSoD 2019 以降の今後の計画は明確です。他のプロジェクトでも引き続き組織に貢献していきます。ドキュメントからセキュリティまで、あらゆる面で完璧になるように努めます。機会があれば、組織のどの会議にも必ず参加します。
利用規約
私は、上記で説明したのと同じやり方で活動することに固く同意し、流産が発生した場合には責任を負います。私はこのプロジェクトに尽力されることを理解しています。また、最高の作品を提供できるように、今シーズンは全シーズンを費やしています。
提案書を最後までお読みいただきありがとうございました。他にもご不明な点がございましたら、お気軽にお問い合わせください。