本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Arduino
- 技术文档工程师：
- AghaSaad04
- 项目名称：
- 提供第三方库文档
- 项目时长：
- 标准时长（3 个月）
Project description
我是一名经验丰富的技术文档工程师。三年多来，我一直在撰写高质量的软件文档、用户指南、手册、算法分析、项目文档和研究论文。在此项目中，我会记录所有的第三方库。我的目标是记录由 Arduino 构建和贡献的库，以便开发者能够充分发挥这些库的全部潜力。我将完成以下任务：
记录库的运行情况 记录如何改进库，使其满足所需需求
示例
Arduino 的 NESController 库需要有充分的记录。其功能、兼容性、示例和应用应添加到其文档中，以供贡献者查看。相关文档中已提及相关用法，还有更多改进空间。Nbiot-arduino 是一个用于访问 NBIoT 模块的 Arduino 库。其文档可通过扩展其用法、构建和测试及调试选项加以改进。还应添加包含代码段的示例。 Arduino 最热门的库 ArduinoJson 有详尽记录，包括如何在各种电台中使用该库、包含每个类和函数说明的 API 参考文档、几乎可以回答每个问题的常见问题解答以及为用户编写程序的 AduinoJson Assistant。同样，对于需要改进和扩展其文档的所有库，应为其做深入介绍。 我具备物联网 (IoT) 领域的经验，对微控制器有基本的了解。我精通各种编程语言，包括 Python、Java、C、C++、HTML5、JavaScript、C#。我非常感兴趣，愿意利用自己的技术写作能力以及电子、微控制器和编程方面的知识，为 Arduino 做出贡献。我渴望进一步了解并提升自己的技能和知识。
由于 Markdown 易于使用的语法和丰富的功能，我将使用 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 个小时以上的时间，但万一出现意外，我会在周末补偿这些时间。在社区凝聚期期间，我将与我的导师讨论沟通方式，并敲定每周的会议、方式和时间。我会及时向导师提供我工作的最新动态，并会通过电子邮件与导师分享我的工作详情。我更喜欢使用团队查看器进行沟通交流，因为该工具使用起来很方便，有很多功能，例如共享屏幕等。
未来计划
2019 年 Google 开发者峰会之后，我未来的计划非常清晰。我会继续在其他项目中为该组织做贡献。从文档的角度到安全角度，我会尽力让它各个方面都完美无缺。有机会的话，我一定会参加组织的任何会议。
条款及条件
我严格同意，我将按照上面说明的方式工作，如有任何流产，须承担相关责任。我了解这个项目需要投入的精力，因此我可以向您保证，我会将整个季节都投入到这个项目中，以便提供最好的成果。
感谢您阅读整个提案。如果您还有其他疑问，请与我联系。