หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ 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 ฉันจะยังคงมีส่วนร่วมกับองค์กรในโปรเจ็กต์อื่นๆ ต่อไป เราจะพยายามทำให้สมบูรณ์แบบในทุกๆ ด้าน ทั้งในแง่ของเอกสารประกอบไปจนถึงด้านความปลอดภัย เราจะเข้าร่วมการประชุมขององค์กรทุกครั้งหากมีโอกาส
ข้อกำหนดและเงื่อนไข
ฉันยืนยันว่าฉันจะทำงานด้วยวิธีเดียวกับที่ฉันอธิบายไว้ข้างต้น และในกรณีที่มีการแท้งบุตร ฉันจะต้องเป็นผู้รับผิดชอบ เราเข้าใจดีว่าโปรเจ็กต์นี้ต้องใช้ความทุ่มเทอย่างมาก และขอรับรองว่าเราจะทุ่มเททั้งฤดูกาลให้กับโปรเจ็กต์นี้เพื่อให้ได้ผลงานที่ดีที่สุด
ขอขอบคุณที่อ่านข้อเสนอทั้งฉบับ โปรดติดต่อเราหากมีข้อสงสัยเพิ่มเติม