Trang này được dịch bởi Cloud Translation API.

Dự án Arduino

Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.

Tóm tắt dự án

Tổ chức nguồn mở:: Arduino
Người viết nội dung kỹ thuật:: AghaSaad04
Tên dự án:: Lập tài liệu trong thư viện bên thứ ba
Thời lượng dự án:: Thời gian tiêu chuẩn (3 tháng)

Mô tả dự án

Tôi là một người viết có kinh nghiệm về kỹ thuật. Tôi đã viết tài liệu phần mềm chất lượng cao, hướng dẫn sử dụng, hướng dẫn, phân tích thuật toán, tài liệu về dự án, tài liệu nghiên cứu trong hơn ba năm. Trong dự án này, tôi sẽ ghi lại tất cả thư viện của bên thứ ba. Mục tiêu của tôi là ghi lại các thư viện do Arduino tạo và đóng góp để các nhà phát triển có thể khai thác hết tiềm năng của chúng. Tôi sẽ hoàn thành những việc sau:

Ghi lại hoạt động của thư viện Tài liệu về cách Cải tiến thư viện để đáp ứng những nhu cầu cần thiết

Ví dụ

Thư viện NESController của Arduino thực sự cần được ghi lại đầy đủ. Tính năng, khả năng tương thích, ví dụ, ứng dụng nên được thêm vào tài liệu của cộng tác viên. Cách sử dụng đã được đề cập trong tài liệu và có thể cải thiện hơn nữa. Nbiot-arduino là một Thư viện Arduino để truy cập vào các mô-đun NBIoT. Bạn có thể cải thiện tài liệu của API này bằng cách mở rộng các Tuỳ chọn sử dụng, Tạo và kiểm thử, gỡ lỗi. Bạn cũng nên đưa các ví dụ chứa đoạn mã vào. Thư viện được gắn dấu sao nhiều nhất của ArduinoJson được ghi lại đầy đủ dưới dạng các ví dụ cho thấy cách sử dụng thư viện ở nhiều trạm, Tài liệu tham khảo API chứa mô tả của từng lớp và chức năng, Câu hỏi thường gặp để trả lời hầu hết mọi câu hỏi và Trợ lý AduinoJson viết chương trình cho người dùng được bao gồm trong tài liệu. Tương tự như vậy, bạn nên tạo tài liệu chuyên sâu cho tất cả thư viện có tài liệu cần cải thiện và mở rộng. Là người có kinh nghiệm trong lĩnh vực Internet của vạn vật (IoT), tôi có kiến thức cơ bản về bộ vi điều khiển. Tôi có khả năng sử dụng thành thạo nhiều ngôn ngữ lập trình, bao gồm Python, Java, C, C++, HTML5, JavaScript, C#. Tôi thực sự quan tâm và sẵn sàng đóng góp cho Arduino thông qua kỹ năng viết kỹ thuật cũng như kiến thức về điện tử, bộ vi điều khiển và lập trình. Tôi mong muốn học hỏi thêm và nâng cao kiến thức cũng như kỹ năng của mình.

Tôi sẽ dùng Markdown để định kiểu cho tất cả bài viết của mình vì phiên bản này có cú pháp dễ sử dụng và nhiều tính năng.

Mẫu

Đây là một trong các mẫu có thể dùng cho tài liệu đó. Tài liệu này có thể được sửa đổi và thêm các mục mới theo yêu cầu của tài liệu.


$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.

Cam kết thời gian và giao tiếp

Tôi sẽ làm việc hơn 45 giờ mỗi tuần, nhưng trong trường hợp xảy ra rủi ro, tôi sẽ đền bù số giờ đó vào cuối tuần.Trong giai đoạn gắn kết cộng đồng, tôi sẽ thảo luận về phương tiện liên lạc và sẽ hoàn thiện các cuộc họp, phương thức và thời gian họp hằng tuần với cố vấn của mình. Tôi sẽ thông báo cho người cố vấn cập nhật về công việc của tôi và sẽ chia sẻ thông tin chi tiết về công việc với cố vấn qua email. Tôi sẽ thích giao tiếp bằng Trình xem nhóm hơn, vì công cụ này dễ sử dụng với nhiều tính năng như chia sẻ màn hình, v.v.

Kế hoạch trong tương lai

Kế hoạch trong tương lai của tôi rất rõ ràng, sau GSoD năm 19. Tôi cũng sẽ tiếp tục đóng góp cho tổ chức trong các dự án khác. Tôi sẽ cố gắng hoàn thiện sản phẩm này ở mọi khía cạnh từ tài liệu cho đến bảo mật. Tôi chắc chắn sẽ tham dự bất kỳ cuộc họp nào của tổ chức nếu có thời gian.

Điều khoản và điều kiện

Tôi hoàn toàn đồng ý rằng tôi sẽ làm việc theo cách như tôi đã giải thích ở trên và trong trường hợp sẩy thai nào đó, tôi sẽ phải chịu trách nhiệm. Tôi hiểu sự cống hiến cần thiết cho dự án này, và tôi đảm bảo rằng tôi sẽ dành toàn bộ mùa giải cho dự án này để có thể làm tốt nhất công việc của mình.

Cảm ơn bạn đã đọc toàn bộ đề xuất. Vui lòng liên hệ với tôi nếu bạn có câu hỏi khác.