โปรเจ็กต์ Arduino
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- Arduino
- นักเขียนเชิงเทคนิค:
- AghaSaad04
- ชื่อโปรเจ็กต์:
- บันทึกไลบรารีของบุคคลที่สาม
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ฉันเป็นนักเขียนเนื้อหาทางเทคนิคที่มีประสบการณ์ ฉันเขียนเอกสารประกอบเกี่ยวกับซอฟต์แวร์ คู่มือผู้ใช้ คู่มือ การวิเคราะห์อัลกอริทึม เอกสารประกอบของโครงการ เอกสารการวิจัยที่มีคุณภาพสูงมามากกว่าสามปี
ในโครงการนี้ เราจะบันทึกไลบรารีของบุคคลที่สามทั้งหมด ฉันมุ่งหมายที่จะบันทึกข้อมูลเกี่ยวกับห้องสมุดที่ Arduino สร้างขึ้นและมีส่วนร่วมเพื่อให้นักพัฒนาแอปได้เห็นศักยภาพทั้งหมดที่มีอยู่ เราจะทํางานต่อไปนี้
บันทึกวิธีการทํางานของไลบรารี
บันทึกวิธีปรับปรุงไลบรารีเพื่อให้รองรับความต้องการที่จำเป็น
ตัวอย่างเช่น
ไลบรารี NESController ของ Arduino ต้องมีการบันทึกไว้อย่างชัดเจน คุณควรเพิ่มฟีเจอร์ ความเข้ากันได้ ตัวอย่าง และการประยุกต์ใช้ในเอกสารประกอบสำหรับผู้ให้ข้อมูลร่วมกัน การใช้งานมีการกล่าวถึงในเอกสารประกอบอยู่แล้ว ซึ่งสามารถปรับปรุงให้ดียิ่งขึ้นได้ Nbiot-arduino เป็นไลบรารี Arduino สําหรับการเข้าถึงโมดูล NBIoT เอกสารประกอบนี้สามารถปรับปรุงได้โดยการขยายการใช้งาน การสร้างและทดสอบ ตัวเลือกการแก้ไขข้อบกพร่อง นอกจากนี้ คุณควรใส่ตัวอย่างที่มีข้อมูลโค้ดด้วย
ไลบรารีที่ได้รับการติดดาวที่สุดของ ArduinoJson มีการบันทึกไว้อย่างดีเป็นตัวอย่างที่แสดงวิธีใช้ไลบรารีในสถานีต่างๆ เอกสารอ้างอิง API ที่มีคำอธิบายคลาสและฟังก์ชันแต่ละรายการ คำถามที่พบบ่อยที่ตอบคำถามแทบทุกคำถาม และ AduinoJson Assistant ที่เขียนโปรแกรมสำหรับผู้ใช้ก็รวมอยู่ในเอกสารประกอบด้วย ในทํานองเดียวกัน คุณควรเขียนเอกสารประกอบอย่างละเอียดสําหรับไลบรารีทั้งหมดที่ต้องปรับปรุงและขยายเอกสารประกอบ
ประสบการณ์ด้านอินเทอร์เน็ตของสรรพสิ่ง (IoT) ทำให้ฉันมีความรู้พื้นฐานเกี่ยวกับไมโครคอนโทรลเลอร์ ฉันเชี่ยวชาญภาษาโปรแกรมต่างๆ เช่น Python, Java, C, C++, HTML5, JavaScript และ C# ฉันสนใจและยินดีที่จะมีส่วนร่วมใน Arduino ผ่านทักษะการเขียนเชิงเทคนิคและความรู้เกี่ยวกับอุปกรณ์อิเล็กทรอนิกส์ ไมโครคอนโทรลเลอร์ และการเขียนโปรแกรม ฉันกระตือรือร้นที่จะได้เรียนรู้เพิ่มเติมและเพิ่มทักษะและความรู้
เราจะใช้ Markdown เพื่อจัดรูปแบบการเขียนทั้งหมดเนื่องจากไวยากรณ์ที่ใช้งานง่ายและชุดฟีเจอร์ที่ครอบคลุม
เทมเพลต
ซึ่งเป็นเทมเพลตหนึ่งที่สามารถใช้สำหรับเอกสารประกอบได้ ซึ่งแก้ไขได้และเพิ่มส่วนใหม่ได้ตามข้อกำหนดของเอกสาร
$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 เพื่อสื่อสาร เนื่องจากใช้งานง่ายและมีฟีเจอร์มากมาย เช่น การแชร์หน้าจอ เป็นต้น
แผนในอนาคต
แผนการในอนาคตของฉันชัดเจนมากหลังจาก GSoD’19 ฉันจะยังคงมีส่วนร่วมกับองค์กรในโปรเจ็กต์อื่นๆ ต่อไป เราจะพยายามทำให้สมบูรณ์แบบในทุกๆ ด้าน ทั้งในแง่ของเอกสารประกอบไปจนถึงด้านความปลอดภัย เราจะเข้าร่วมการประชุมขององค์กรทุกครั้งหากมีโอกาส
ข้อกำหนดและเงื่อนไข
ฉันยืนยันว่าฉันจะทำงานด้วยวิธีเดียวกับที่ฉันอธิบายไว้ข้างต้น และในกรณีที่มีการแท้งบุตร ฉันจะต้องเป็นผู้รับผิดชอบ เราเข้าใจดีว่าโปรเจ็กต์นี้ต้องใช้ความทุ่มเทอย่างมาก และขอรับรองว่าเราจะทุ่มเททั้งฤดูกาลให้กับโปรเจ็กต์นี้เพื่อให้ได้ผลงานที่ดีที่สุด
ขอขอบคุณที่อ่านข้อเสนอทั้งฉบับ โปรดติดต่อเราหากมีข้อสงสัยเพิ่มเติม
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-07-25 UTC
[null,null,["อัปเดตล่าสุด 2025-07-25 UTC"],[[["\u003cp\u003eThis Google Season of Docs project focuses on improving the documentation of third-party libraries used within the Arduino ecosystem.\u003c/p\u003e\n"],["\u003cp\u003eThe project aims to create comprehensive documentation, including features, installation instructions, contribution guidelines, and support information for each library.\u003c/p\u003e\n"],["\u003cp\u003eThe technical writer, AghaSaad04, has extensive experience in technical writing and possesses relevant knowledge of programming languages and micro-controllers.\u003c/p\u003e\n"],["\u003cp\u003eA standardized template will be used for documenting the libraries, ensuring consistency and clarity.\u003c/p\u003e\n"],["\u003cp\u003eThe project will involve a significant time commitment, with the writer dedicating 45+ hours per week and maintaining regular communication with their mentor.\u003c/p\u003e\n"]]],["The project aims to improve documentation for Arduino's third-party libraries. The technical writer, AghaSaad04, will document library workings and improvements, focusing on Arduino-made and contributed libraries. Key actions include creating in-depth documentation for each library, including features, installation, contribution guidelines, support, and licensing, using a provided Markdown template. The writer will dedicate 45+ hours weekly, communicating updates via email and Team Viewer with the mentor. The project will be standard length (3 months).\n"],null,["# Arduino project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\nProject summary\n---------------\n\nOpen source organization:\n: Arduino\n\nTechnical writer:\n: AghaSaad04\n\nProject name:\n: Document third-party libraries\n\nProject length:\n: Standard length (3 months)\n\nProject description\n-------------------\n\nI am an experienced technical writer. I have been writing high quality software documentation, user-guides, manuals, algorithm analysis, project documentation, research paper for more than three years.\nIn this project, I will document all the third-party libraries. I aim to document the libraries that are Arduino-made and contributed so that all their potential is exposed towards developers. I will accomplish the following tasks:\n\nDocument the working of the library\nDocument how to Improve the libraries to make them accommodate the required needs\n\n### For Example\n\nArduino's NESController library really needs to be well-documented. Its features, compatibility, examples, applications should be added in its documentation for its contributors. Usage is already mentioned in the documentation which can be improved to a greater extent. Nbiot-arduino is an Arduino Library for accessing NBIoT modules. Its documentation can be improved by extending its Usage, Build \\& Test, Debug Options. Examples containing code snippets should also be included.\nArduino's most starred library ArduinoJson is well-documented as examples showing how to use the library in various stations, API Reference containing the description of each class and function, FAQ that answers to virtually every question and AduinoJson Assistant which writes programs for its users are included in the documentation. Similarly, in-depth documentation should be done for all the libraries whose documentation needs to be improved and extended.\nBeing experienced in the field of Internet of Things (IoT), I have the basic knowledge about micro-controllers. I have proficiency in various programming languages including Python, Java, C, C++, HTML5, JavaScript, C#. I am highly interested and willing to contribute to Arduino through my technical writing skills and the knowledge about electronics, micro-controllers, programming. I am eager to learn more and enhance my skills and knowledge.\n\nI will be using Markdown for styling of all my writing due to its easy-to-use syntax and extensive set of features.\n\n### Template\n\nThis is one of the templates that can be used for the documentation. It can be modified and new sections can be added according to the requirements of the document. \n\n\n $projectName/Library Name\n --------\n In this section, I will give background information of the library, \n what does this library use, on what languages and framework it is based on, \n what are the dependencies of this library/project where it will be used\n\n Features\n --------\n I will add features of the project here like\n - this library creates connection between server and client\n - Make things faster\n\n Installation\n ------------\n In this section I will add the installation procedure and dependencies that \n needs to be installed.\n Install $project by running:\n install project\n\n Contribute\n ----------\n For the contributors, I will add this section in documentation.\n - Issue Tracker: github.com/$project/$project/issues\n - Source Code: github.com/$project/$project\n\n Support\n -------\n This section can also be added\n If you are having issues, please let us know.\n We have a mailing list located at: project@google-groups.com\n\n License\n -------\n This section will tell about the license of the project.\n This project is licensed under the BSD.\n\n### Time commitment and communication\n\nI will give 45+ hours a week but in case of any mishap, I will compensate those\nhours on weekends.During the community bond period, I will discuss communication means and will finalize weekly meetings, means and time for those meetings with my mentor. I will keep my mentor up to date about my work; will share my work details via email to my mentor. I will prefer Team Viewer for communicating, as it is easy to use with lots of features like share screens etc.\n\n### Future Plans\n\nMy future plans are very clear, after GSoD'19. I will keep contributing to the organization in other projects too. I will try to make it perfect in all aspects from documentation perspective to security perspective. I will surely attend any meeting of the organization if I ever get a chance.\n\n### Terms \\& Conditions\n\nI solemnly agree that I will work in the same way that I have explained above and\nin case of any miscarriage, I will be held accountable. I understand the dedication\nrequired for this project, I assure you that I am dedicating my whole season for this project so that I can provide the best work.\n\nThank you for reading the whole proposal. Please reach out to me if there are any further queries."]]
