このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。
プロジェクトの概要
- オープンソース組織:
- Arduino
- テクニカル ライター:
- AghaSaad04
- プロジェクト名:
- サードパーティ ライブラリを記述する
- プロジェクト期間:
- 標準期間（3 か月）
プロジェクトの説明
私は経験豊富な技術ライターです。3 年以上にわたって、質の高いソフトウェアのドキュメント、ユーザーガイド、マニュアル、アルゴリズム分析、プロジェクトのドキュメント、研究論文を作成してきました。このプロジェクトでは、すべてのサードパーティ ライブラリを文書化します。Arduino で開発され貢献したライブラリをドキュメント化し、その可能性をデベロッパーに最大限にアピールすることを目指しています。次のタスクを行います。
ライブラリの動作を文書化します。必要なニーズに合わせてライブラリを改善する方法も文書化します。
例:
Arduino の NESController ライブラリは、十分なドキュメントが用意されている必要があります。機能、互換性、例、アプリケーションは、コントリビュータ向けのドキュメントに追加する必要があります。使用方法はすでにドキュメントに記載されていますが、さらに改善の余地があります。Nbiot-arduino は、NBIoT モジュールにアクセスするための Arduino ライブラリです。使用方法、ビルドとテスト、デバッグのオプションを拡張することで、ドキュメントを改善できます。コード スニペットを含む例も含める必要があります。Arduino で最もスター数が多いライブラリである ArduinoJson は、さまざまなステーションでライブラリを使用する方法を示す例、各クラスと関数の説明を含む API リファレンス、ほぼすべての質問に回答するよくある質問、ユーザーのプログラムを作成する AduinoJson アシスタントなど、ドキュメントが充実しています。同様に、ドキュメントの改善と拡張が必要なすべてのライブラリについて、詳細なドキュメントを作成する必要があります。モノのインターネット（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 後の私の今後の計画は明確です。他のプロジェクトでも引き続き組織に貢献していきます。ドキュメントの観点からセキュリティの観点まで、あらゆる面で完璧なものにするよう努めます。機会があれば、必ず組織の会議に参加します。
利用規約
私は、上記に説明した方法で作業し、流産した場合は責任を負うことを厳粛に同意します。私はこのプロジェクトの献身的な取り組みを理解しています。最高の仕事を提供できるように、このプロジェクトに全シーズンを費やしていることを約束します。
提案書全体をお読みいただきありがとうございます。他にご不明な点がございましたら、お気軽にお問い合わせください。