이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Arduino 프로젝트

이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 구성:: Arduino
기술 문서 작성자:: AghaSaad04
프로젝트 이름:: 서드 파티 라이브러리 문서화
프로젝트 기간:: 표준 기간 (3개월)

Project description

저는 숙련된 기술 문서 작성자입니다. 3년 넘게 고품질 소프트웨어 문서, 사용자 가이드, 매뉴얼, 알고리즘 분석, 프로젝트 문서, 연구 논문을 작성해 왔습니다. 이 프로젝트에서는 모든 서드 파티 라이브러리를 문서화하겠습니다. 저는 Arduino에서 만들어지고 기여한 라이브러리를 문서화하여 모든 잠재력이 개발자에게 노출되도록 하는 것을 목표로 하고 있습니다. 다음 작업을 완료할 예정입니다.

라이브러리 작동 문서화 필요한 요구사항을 수용할 수 있도록 라이브러리를 개선하는 방법 문서화

예를 들어

Arduino의 NESController 라이브러리는 문서화되어야 합니다. 기능, 호환성, 예시, 애플리케이션은 참여자를 위한 문서에 추가해야 합니다. 사용은 문서에 이미 언급되어 있으며 더 개선될 수 있습니다. Nbiot-arduino는 NBIoT 모듈에 액세스하기 위한 Arduino 라이브러리입니다. 사용, 빌드 및 테스트, 디버그 옵션을 확장하여 문서를 개선할 수 있습니다. 코드 스니펫이 포함된 예시도 포함해야 합니다. Arduino에서 가장 많은 별표표시가 있는 라이브러리인 ArduinoJson은 다양한 스테이션에서 라이브러리를 사용하는 방법을 보여주는 예시, 각 클래스 및 함수에 관한 설명이 포함된 API 참조, 거의 모든 질문에 답변하는 FAQ, 사용자를 위해 프로그램을 작성하는 AduinoJson 어시스턴트로 문서화되어 있습니다. 마찬가지로 문서가 개선되고 확장되어야 하는 모든 라이브러리에 대해 심층 문서를 작성해야 합니다. 사물 인터넷 (IoT) 분야에서 경험을 쌓으면서 마이크로 컨트롤러에 대한 기본 지식을 가지고 있습니다. Python, Java, C, C++, HTML5, JavaScript, C# 등 다양한 프로그래밍 언어에 능숙합니다. 저는 기술 문서 작성 기술과 전자, 마이크로컨트롤러, 프로그래밍에 대한 지식을 통해 Arduino에 기여하고자 합니다. 더 많은 것을 배우고 기술과 지식을 향상시키고자 합니다.

사용하기 쉬운 문법과 광범위한 기능 세트 때문에 모든 글의 스타일을 지정하는 데 마크다운을 사용하겠습니다.

템플릿

문서에 사용할 수 있는 템플릿 중 하나입니다. 문서의 요구사항에 따라 수정하고 새 섹션을 추가할 수 있습니다.


$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를 선호합니다. 화면 공유와 같은 다양한 기능을 간편하게 사용할 수 있기 때문입니다.

향후 계획

2019년 GSoD 이후의 계획은 매우 분명합니다. 다른 프로젝트에서도 조직에 계속 기여할 것입니다. 문서 측면에서 보안 측면까지 모든 측면에서 완벽하게 만들도록 노력하겠습니다. 기회가 된다면 조직의 회의에 참석하겠습니다.

이용약관

본인은 위에 설명한 것과 동일한 방식으로 업무를 수행할 것이며 유산이 발생할 경우 책임을 질 것에 대해 엄숙히 동의합니다. 이 프로젝트에 필요한 노력을 잘 알고 있으며, 최선을 다해 작업을 제공할 수 있도록 한 시즌 내내 이 프로젝트에 전념하고 있음을 알려드립니다.

제안서 전체를 읽어주셔서 감사합니다. 다른 궁금한 점이 있으면 언제든지 문의해 주세요.