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 Google Phần Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Tiếng Arduino
- Người viết nội dung kỹ thuật:
- AghaSaad04
- Tên dự án:
- Tài liệu trong thư viện của bên thứ ba
- Thời lượng dự án:
- Thời lượng tiêu chuẩn (3 tháng)
Mô tả dự án
Tôi là một người viết nội dung 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 ba năm. Trong dự án này, tôi sẽ ghi lại tất cả cá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 ra và đóng góp để nhà phát triển có thể khai thác hết tiềm năng của thư viện đó. Tôi sẽ hoàn thành các công việc sau:
Ghi lại hoạt động của thư viện Tài liệu về cách Cải thiện thư viện để đáp ứng các nhu cầu bắt buộc
Ví dụ
Thư viện NESController của Arduino thực sự cần được ghi lại đầy đủ. Bạn phải bổ sung các tính năng, khả năng tương thích, ví dụ, ứng dụng vào tài liệu dành cho 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 ứng dụng bằng cách mở rộng phần Sử dụng, Xây dựng và Kiểm thử, Tuỳ chọn gỡ lỗi. Bạn cũng nên bao gồm các ví dụ chứa đoạn mã. Thư viện được gắn dấu sao nhiều nhất của ArduinoJson được mô tả đầ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ả về từng lớp và chức năng, Câu hỏi thường gặp để trả lời hầu hết các 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ự, bạn nên viết tài liệu chuyên sâu cho tất 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ộ vi điều khiển. 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 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 và kiến thức về điện tử, bộ vi điều khiển, lập trình. Tôi mong muốn học hỏi thêm và nâng cao kỹ năng cũng như kiến thức của mình.
Tôi sẽ dùng Markdown để tạo kiểu cho mọi bài viết của mình do có cú pháp dễ sử dụng và bộ tính năng phong phú.
Template
Đây là một trong những mẫu mà bạn có thể sử dụng cho tài liệu. Tài liệu này có thể được sửa đổi và 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 nếu có sai sót, tôi sẽ trả thù lao cho những giờ đó vào cuối tuần.Trong thời gian gắn kết với cộng đồng, tôi sẽ thảo luận về các phương thức liên lạc và sẽ chốt lại các cuộc họp hằng tuần, cách thức và thời gian cho các cuộc gặp gỡ với cố vấn của mình. Tôi sẽ luôn cập nhật công việc của mình cho cố vấn; tôi sẽ chia sẻ chi tiết công việc của tôi với cố vấn qua email. Tôi sẽ thích người xem nhóm hơn để 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
Kế hoạch tương lai của tôi rất rõ ràng, sau GSoD'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 mọi khía cạnh, từ quan điểm 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ó cơ hội.
Điều khoản và điều kiện
Tôi tuyệt đối đồng ý rằng tôi sẽ làm việc theo cách như đã 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ự tận tâm cần thiết cho dự án này, và tôi đảm bảo với bạn rằng tôi đang cống hiến toàn bộ mùa giải của mình 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ó thêm câu hỏi.