本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Arduino
- 技术文档工程师：
- AghaSaad04
- 项目名称：
- 记录第三方库
- 项目时长：
- 标准时长（3 个月）
Project description
我是一名经验丰富的技术文档工程师。我编写高质量的软件文档、用户指南、手册、算法分析、项目文档和研究论文已超过三年。在本项目中，我将记录所有第三方库。我的目标是记录由 Arduino 创建和贡献的库，以便向开发者展示其所有潜力。我将完成以下任务：
记录库的运作方式 记录如何改进库以满足所需需求
示例
Arduino 的 NESController 库确实需要有完备的资料。您应在其文档中为贡献者提供其功能、兼容性、示例和应用。文档中已经提到了用法，还可以进一步改进。Nbiot-arduino 是一个用于访问 NBIoT 模块的 Arduino 库。可以通过扩展其“ Usage”、“Build &Test”和“Debug Options”来改进其文档。还应添加包含代码段的示例。 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 小时以上的时间，但如果发生任何意外情况，我会在周末补上这些时间。在社区互动期间，我会讨论沟通方式，并与导师确定每周会议、会议方式和时间。我会及时向导师通报工作进展；并通过电子邮件与导师分享工作详情。我更倾向于使用 Team Viewer 进行沟通，因为它易于使用，并且具有共享屏幕等众多功能。
未来计划
在 GSoD’19 之后，我的未来计划非常明确。我也将继续在其他项目中为组织做出贡献。我会努力从文档和安全等各个方面完善它。只要有时间，我一定会参加组织的任何会议。
条款及条件
本人郑重承诺，将按照上述方式操作，如果发生任何流产，本人将承担相应责任。我理解这个项目需要投入大量的心血，我保证，我将全力以赴完成这个项目，以便提供最好的成果。
感谢您阅读整个提案。如果您还有其他疑问，欢迎随时与我联系。