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

Arduino 프로젝트

이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:: 아르두이노
테크니컬 라이터:: AghaSaad04
프로젝트 이름:: 서드 파티 라이브러리 문서화
프로젝트 기간:: 표준 기간 (3개월)

Project description

숙련된 테크니컬 라이터입니다. 저는 3년 넘게 양질의 소프트웨어 문서, 사용자 가이드, 매뉴얼, 알고리즘 분석, 프로젝트 문서, 연구 논문을 작성해 왔습니다. 이 프로젝트에서는 모든 서드 파티 라이브러리를 문서화하겠습니다. 저는 Arduino에서 제작하고 기여한 라이브러리를 문서화하여 이러한 라이브러리의 모든 잠재력을 개발자에게 노출하는 것을 목표로 하고 있습니다. 다음 작업을 수행합니다.

라이브러리 작동 문서화 라이브러리를 개선하여 필요한 요구사항을 수용하는 방법을 문서화합니다.

예:

Arduino의 NESController 라이브러리는 정말 잘 문서화되어 있어야 합니다. 기여자용 문서에 기능, 호환성, 예시, 애플리케이션을 추가해야 합니다. 사용법은 문서에 이미 언급되어 있지만 훨씬 더 개선될 수 있습니다. Nbiot-arduino는 NBIoT 모듈에 액세스하기 위한 Arduino 라이브러리입니다. 사용량, 빌드 및 테스트, 디버그 옵션을 확장하여 문서를 개선할 수 있습니다. 코드 스니펫이 포함된 예도 포함해야 합니다. Arduino에서 가장 별표 표시된 라이브러리 ArduinoJson은 다양한 스테이션에서 라이브러리를 사용하는 방법을 보여주는 예시로 잘 문서화되어 있습니다. 각 클래스와 기능에 대한 설명이 포함된 API 참조, 거의 모든 질문에 대한 답변이 포함된 FAQ, 사용자를 위해 프로그램을 작성하는 AduinoJson Assistant가 문서에 포함되어 있습니다. 마찬가지로, 심층 문서는 문서를 개선하고 확장해야 하는 모든 라이브러리에 대해 작성되어야 합니다. 사물 인터넷 (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시간 이상을 할애할 예정이지만, 문제가 발생할 경우 주말에 해당 근무 시간을 보전해 드리겠습니다. 멘토에게 제 작업에 대한 최신 정보를 제공하고, 멘토에게 이메일을 통해 작업 세부정보를 공유할 것입니다. 화면 공유 등의 다양한 기능을 사용하기 쉽기 때문에 팀 뷰어를 선호합니다.

향후 계획

GSoD’19 이후 내 미래 계획은 매우 명확합니다. 다른 프로젝트에서도 계속 조직에 기여할 것입니다. 문서 관점에서 보안 관점에 이르기까지 모든 측면에서 완벽하게 만들기 위해 노력하겠습니다. 기회가 생기면 조직의 모든 회의에 참석할 것입니다.

이용약관

본인은 위에서 설명한 방식으로 업무를 처리할 것이며, 유산 시 책임을 질 것에 대해 엄숙히 동의합니다. 이 프로젝트에 대한 헌신을 이해합니다. 최고의 성과를 낼 수 있도록 이 프로젝트에 전 시즌을 할애하겠습니다.

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