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 nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.

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:: Ghi lại thư viện của bên thứ ba
Độ dài dự án:: Thời hạn tiêu chuẩn (3 tháng)

Mô tả dự án

Tôi là một nhà văn kỹ thuật có kinh nghiệm. 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 dự án, bài nghiên cứu trong hơn 3 năm. Trong dự án này, tôi sẽ ghi lại tất cả thư viện 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 để nhà phát triển có thể khai thác hết tiềm năng của các thư viện đó. Tôi sẽ hoàn thành các nhiệm vụ sau:

Ghi lại cách hoạt động của thư viện Ghi lại cách cải thiện thư viện để đáp ứng các nhu cầu cần thiết

Ví dụ

Thư viện NESController của Arduino thực sự cần được ghi chép đầy đủ. Các tính năng, khả năng tương thích, ví dụ và ứng dụng của ứng dụng phải được thêm vào tài liệu dành cho người đóng góp. Tài liệu đã đề cập đến cách sử dụng, nhưng 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, Xây dựng và kiểm thử, gỡ lỗi. Bạn cũng nên đưa vào các ví dụ chứa đoạn mã. Thư viện được gắn nhiều dấu sao nhất của Arduino là ArduinoJson được ghi nhận đầy đủ dưới dạng ví dụ về cách sử dụng thư viện này trong nhiều trạm, Tài liệu tham khảo API chứa nội dung mô tả về từng lớp và hàm, 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 đưa vào tài liệu. Tương tự, bạn nên tạo tài liệu chuyên sâu cho tất cả các thư viện cần cải thiện và mở rộng tài liệu. 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ộ điều khiển vi mô. Tôi 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 rất quan tâm và sẵn sàng đóng góp cho Arduino thông qua kỹ năng viết kỹ thuật và kiến thức về điện tử, bộ điều khiển vi mô, lập trình. Tôi rất mong được tìm hiểu thêm và nâng cao kỹ năng cũng như kiến thức của mình.

Tôi sẽ sử dụng Markdown để tạo kiểu cho tất cả bài viết của mình do cú pháp dễ sử dụng và bộ tính năng phong phú.

Mẫu

Đây là một trong những mẫu có thể dùng cho tài liệu. Tài liệu này có thể được sửa đổi và bạn có thể thêm các phần 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 về thời gian và giao tiếp

Tôi sẽ dành hơn 45 giờ mỗi tuần nhưng trong trường hợp có sự cố, tôi sẽ bù lại những giờ đó vào cuối tuần.Trong thời gian gắn bó với cộng đồng, tôi sẽ thảo luận về phương thức liên lạc và sẽ chốt các cuộc họp hằng tuần, phương thức và thời gian cho các cuộc họp đó với người cố vấn của mình. Tôi sẽ cập nhật cho người cố vấn về công việc của mình; sẽ chia sẻ thông tin chi tiết về công việc của mình qua email với người cố vấn. Tôi sẽ ưu tiên sử dụng Team Viewer để giao tiếp vì ứng dụng 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

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

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

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

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 nào khác.