โปรเจ็กต์ Arduino

หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs

ข้อมูลสรุปของโปรเจ็กต์

องค์กรโอเพนซอร์ส:

อาร์ดูโน

ผู้เขียนด้านเทคนิค:

AghaSaad04

ชื่อโปรเจ็กต์:

ไลบรารีเอกสารของบุคคลที่สาม

ระยะเวลาของโปรเจ็กต์:

ระยะเวลามาตรฐาน (3 เดือน)

คำอธิบายโปรเจ็กต์

ผมเป็นนักเขียนที่มีประสบการณ์ ฉันเขียนเอกสารประกอบซอฟต์แวร์คุณภาพสูง คู่มือผู้ใช้ คู่มือ การวิเคราะห์อัลกอริทึม เอกสารประกอบของโปรเจ็กต์ งานวิจัยมานานกว่า 3 ปี ในโครงการนี้ เราจะบันทึกไลบรารีของบุคคลที่สามทั้งหมด ฉันตั้งเป้าที่จะบันทึกไลบรารีต่างๆ ที่ผลิตโดย Arduino และมีส่วนร่วมเพื่อให้นักพัฒนาได้เข้าถึงศักยภาพทั้งหมดที่มีอยู่ ฉันจะทำสิ่งต่อไปนี้

บันทึกการทำงานของไลบรารี เอกสารเกี่ยวกับวิธีปรับปรุงไลบรารีให้รองรับความต้องการที่จำเป็น

ตัวอย่าง

ไลบรารี NESController ของ Arduino ต้องมีการบันทึกอย่างละเอียด ควรเพิ่มฟีเจอร์ ความเข้ากันได้ ตัวอย่าง และแอปพลิเคชันไว้ในเอกสารประกอบสำหรับผู้ร่วมให้ข้อมูล การใช้งานมีอยู่แล้วในเอกสารประกอบ ซึ่งสามารถปรับปรุงได้มากยิ่งขึ้น Nbiot-arduino คือไลบรารี Arduino สำหรับการเข้าถึงโมดูล NBIoT สามารถปรับปรุงเอกสารประกอบได้โดยการขยายตัวเลือกการใช้งาน การสร้างและทดสอบ การแก้ไขข้อบกพร่อง ควรใส่ตัวอย่างที่มีข้อมูลโค้ดด้วย ห้องสมุด ArduinoJson ที่ได้รับการติดดาวมากที่สุดของ 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: [e-mail]

License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.

ความมุ่งมั่นด้านเวลาและการสื่อสาร

ฉันจะหาเวลามากกว่า 45 ชั่วโมงต่อสัปดาห์แต่หากเกิดเหตุขัดข้องใดๆ ฉันจะชดเชยเวลาให้บริการเหล่านั้นในวันหยุดสุดสัปดาห์ ระหว่างช่วงสร้างความสัมพันธ์ของชุมชน ฉันจะพูดคุยถึงวิธีการติดต่อและสรุปการประชุมรายสัปดาห์ วิธีการ และเวลาสำหรับการประชุมกับที่ปรึกษา ฉันจะแจ้งให้ Mentor ทราบเกี่ยวกับงานของฉันอยู่เสมอ และจะแชร์รายละเอียดงานของฉันผ่านทางอีเมลกับ Mentor ของฉัน ฉันต้องการใช้ Team Viewer สำหรับการสื่อสาร เนื่องจากใช้งานได้ง่ายกับฟีเจอร์มากมาย เช่น การแชร์หน้าจอ ฯลฯ

แผนในอนาคต

แผนในอนาคตของฉันชัดเจนมากหลังจาก GSoD ปี 2019 ฉันจะคอยมีส่วนร่วมกับองค์กรในโปรเจ็กต์อื่นๆ ด้วย ฉันจะพยายามทําให้สมบูรณ์ในทุกด้าน ตั้งแต่มุมมองเอกสารไปจนถึงความปลอดภัย ผมจะเข้าร่วมการประชุมขององค์กรทุกครั้งหากมีโอกาส

ข้อกำหนดและเงื่อนไข

ฉันเห็นด้วยอย่างยิ่งว่าฉันจะทำงานอย่างที่ได้อธิบายไว้ข้างต้น และในกรณีที่มีการแท้ง ฉันต้องรับผิดชอบ เราเข้าใจความทุ่มเทที่จำเป็นสำหรับโปรเจ็กต์นี้ ฉันขอรับรองว่าฉันจะทุ่มเททั้งฤดูกาลของฉันให้กับโปรเจ็กต์นี้ เพื่อที่ฉันจะได้สร้างผลงานที่ดีที่สุด

ขอขอบคุณที่อ่านข้อเสนอทั้งหมด โปรดติดต่อเราหากมีคำถามเพิ่มเติม