このページには、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 に貢献したいと思っています。より多くのことを学び、スキルと知識を向上させたい。
使いやすい構文と豊富な機能を備えているため、すべての文章のスタイル設定に Markdown を使用します。
テンプレート
これは、ドキュメントに使用できるテンプレートの一つです。ドキュメントの要件に応じて、変更や新しいセクションの追加が可能です。
$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 の後、私の将来の計画はとても明確です。他のプロジェクトでも引き続きこの団体に貢献したいと思っています。ドキュメントの観点からセキュリティの観点まで、あらゆる面で完璧なものにするよう努めます。機会があれば、組織のどの会議にも出席するつもりです。
利用規約
上記で説明したのと同じ要領で業務を行い、流産が発生した場合には責任を問われることに、厳重に合意します。このプロジェクトのために尽力されることはわかります。これからも、最善の成果を提供できるよう、私は今シーズンずっとこのプロジェクトのために全力を尽くします。
提案を最後までお読みいただきありがとうございました。他にもご不明な点がございましたら、お気軽にお問い合わせください。