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