Эта страница переведена с помощью Cloud Translation API.

Ардуино проект

На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.

Краткое описание проекта

Организация с открытым исходным кодом:: Ардуино
Технический писатель:: АгаСаад04
Название проекта:: Документирование сторонних библиотек
Длина проекта:: Стандартная продолжительность (3 месяца)

Описание Проекта

Я опытный технический писатель. Я пишу высококачественную документацию по программному обеспечению, руководства пользователя, инструкции, анализ алгоритмов, проектную документацию, исследовательские работы более трех лет. В этом проекте я буду документировать все сторонние библиотеки. Я стремлюсь документировать библиотеки, созданные и предоставленные Arduino, чтобы весь их потенциал был раскрыт разработчикам. Я решу следующие задачи:

Документируйте работу библиотеки. Документируйте, как улучшить библиотеки, чтобы они соответствовали необходимым потребностям.

Например

Библиотека NESController Arduino действительно должна быть хорошо документирована. Его функции, совместимость, примеры и приложения должны быть добавлены в документацию для его участников. Использование уже упомянуто в документации, которая может быть улучшена в большей степени. Nbiot-arduino — это библиотека Arduino для доступа к модулям NBIoT. Его документацию можно улучшить, расширив параметры использования, сборки и тестирования и отладки. Также следует включить примеры, содержащие фрагменты кода. Самая популярная библиотека 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 часов в неделю, но в случае каких-либо происшествий я компенсирую эти часы по выходным. В течение периода связей с сообществом я буду обсуждать средства общения и завершать еженедельные встречи, средства и время для этих встреч с моим наставником. Я буду держать своего наставника в курсе своей работы; поделюсь подробностями своей работы по электронной почте моему наставнику. Для общения я предпочитаю Team Viewer, поскольку он прост в использовании и имеет множество функций, таких как совместное использование экранов и т. д.

Планы на будущее

Мои планы на будущее после GSoD'19 очень ясны. Я буду продолжать вносить вклад в организацию и в других проектах. Я постараюсь сделать его идеальным во всех аспектах: от документации до безопасности. Я обязательно приду на любое собрание организации, если у меня когда-нибудь появится такая возможность.

Условия использования

Я торжественно соглашаюсь, что буду работать так же, как объяснил выше, и в случае любого выкидыша буду нести ответственность. Я понимаю, какая преданность делу требуется для этого проекта, и уверяю вас, что я посвящаю этому проекту весь свой сезон, чтобы обеспечить лучшую работу.

Спасибо, что прочитали все предложение. Пожалуйста, свяжитесь со мной, если возникнут дополнительные вопросы.