หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- INCF
- ผู้เขียนด้านเทคนิค:
- คุณภาพสูง
- ชื่อโปรเจ็กต์:
- เอกสารการฝึก LORIS สำหรับประสาทวิทยาศาสตร์แบบเปิดที่ทำซ้ำได้
- ระยะเวลาของโปรเจ็กต์:
- วิ่งเป็นเวลานาน (5 เดือน)
คำอธิบายโปรเจ็กต์
ด. บทคัดย่อ
Longitudinal Online Research and Imaging System (LORIS) คือแพลตฟอร์มการจัดการโครงการแบบเว็บสำหรับการวิจัยเกี่ยวกับระบบประสาทและสนับสนุนโครงการริเริ่มต่างๆ ของ Open Science เอกสารประกอบมีบทบาทสำคัญใน LORIS โดยเฉพาะอย่างยิ่ง เอกสารประกอบจะช่วยให้ผู้ใช้และนักพัฒนาแอป LORIS เข้าใจรายละเอียดซอฟต์แวร์เพื่อให้สามารถใช้แพลตฟอร์มหรือมีส่วนร่วมในการพัฒนาซอฟต์แวร์ได้ดียิ่งขึ้น ในระหว่างนี้ ควรอัปเดตเอกสารประกอบ LORIS ด้วย โปรเจ็กต์นี้มีเป้าหมายเพื่อช่วย LORIS ปรับปรุงเอกสารประกอบ
2. สถานะปัจจุบัน
ปัจจุบัน LORIS ใช้ GitHub Wiki, อ่านเอกสาร และเว็บไซต์ LORIS.ca เพื่อโฮสต์เอกสารประกอบทั้งหมด โดยเฉพาะอย่างยิ่ง LORIS GitHub Wiki มีให้โฮสต์เอกสารของ LORIS จำนวนมากที่สุด ส่วนบทแนะนำ การนำเสนอ คู่มือการใช้งาน และขั้นตอนแนะนำเพิ่มเติมของ LORIS ได้รับการโฮสต์ไว้ในหลายแพลตฟอร์ม เอกสารประกอบเกี่ยวกับ LORIS ฉบับปัจจุบันเป็นคู่มือสำหรับนักพัฒนาและผู้ใช้ LORIS แต่คุณอาจได้รับประโยชน์จากการพัฒนาและการจัดระเบียบอื่นๆ ในอนาคต โดยเฉพาะในการอัปเดตเอกสารและการปรับปรุงรายละเอียดทางเทคนิค
3. ประโยชน์ที่มีต่อชุมชน
การปรับปรุงเอกสารการฝึกอบรมของ LORIS สำหรับประสาทวิทยาศาสตร์แบบเปิดที่ทำซ้ำได้ช่วยให้นักวิจัยและนักพัฒนาซอฟต์แวร์ได้รับประโยชน์จากเครื่องมือที่ใช้ง่ายยิ่งขึ้น เพื่อปรับปรุงการรวบรวมข้อมูลในการศึกษา กล่าวคือ โปรเจ็กต์อาจอัปเดตและปรับปรุงเอกสารประกอบการติดตั้ง/ตั้งค่า LORIS ตลอดจนเนื้อหาผู้ใช้ปลายทางสำหรับการฝึกอบรมผู้ใช้ใหม่ นอกจากนี้ โครงการยังมีเป้าหมายเพื่อช่วยในการโอนย้ายและอัปเดตเอกสารจาก LORIS GitHub wiki ไปเป็นการอ่านเอกสาร ในขณะเดียวกัน โปรเจ็กต์อาจจัดทำแผนภาพฐานข้อมูลเพื่อสื่อสารความสัมพันธ์ของข้อมูลและปรับปรุงการแสดงข้อมูลทางสถาปัตยกรรม ท้ายที่สุด โปรเจ็กต์นี้จะอัปเดตและปรับปรุงเนื้อหาที่แนะนำผู้คนให้รู้จัก LORIS, บริบทวิทยาศาสตร์ที่เปิดกว้าง และกรณีการใช้งาน
4. จุดแข็งส่วนบุคคลสำหรับโครงการ
ช่วง 2-3 ปีที่ผ่านมา ผมได้เข้าร่วมโครงการทางเทคนิคหลายโครงการ ซึ่งได้พัฒนาความเชี่ยวชาญด้านการเขียนเชิงเทคนิค โดยเฉพาะอย่างยิ่ง ฉันรับผิดชอบงานเขียนเอกสารในโครงการต่างๆ ของทีมที่ผ่านมาและเชื่อว่ามีประสบการณ์เพียงพอในด้านการใช้เครื่องมือเขียนเชิงเทคนิค เช่น Read the Docs, Sphinx, Mkdocs, Markdown, LaTeX เป็นต้น ในขณะเดียวกัน ประสบการณ์การสอนที่ผ่านมาในหลักสูตร STEM ได้ช่วยพัฒนาทักษะด้านการสื่อสารเชิงเทคนิคอีกด้วย เอกสารการฝึกอบรมของ LORIS สำหรับโครงการประสาทวิทยาแบบเปิดที่ทำซ้ำได้กับ INCF เป็นโอกาสที่ดีสำหรับการนำเทคนิคการเขียนเชิงเทคนิคไปใช้กับ LORIS ยิ่งไปกว่านั้น ฉันสนใจในสาขาการถ่ายภาพระบบประสาทมากและพยายามหาโอกาสนำความรู้ทางเทคนิคมาใช้ในสาขานี้ เอกสารการฝึกอบรม LORIS สำหรับโครงการประสาทวิทยาแบบเปิดที่สามารถทำให้เกิดซ้ำได้กับ INCF จะเป็นประสบการณ์ที่มีค่าสำหรับฉัน
V. สิ่งที่ส่งมอบ
- ย้ายข้อมูลและอัปเดตเอกสาร LORIS ปัจจุบัน
- ตรวจสอบ อัปเดต และปรับปรุงเอกสารประกอบการติดตั้ง/ตั้งค่า LORIS และเติมเต็มช่องว่างในเนื้อหาผู้ใช้ปลายทางสำหรับการฝึกอบรมผู้ใช้ใหม่
- ช่วยสร้างแผนภาพฐานข้อมูลเพื่อสื่อสารความสัมพันธ์ของข้อมูล (เช่น วิชา การเยี่ยมชมการศึกษา) และปรับปรุงการแสดงข้อมูลทางสถาปัตยกรรม
- ช่วยอัปเดตและปรับปรุงเอกสารประกอบ LORIS API
- ช่วยอัปเดตและปรับปรุงเนื้อหาที่แนะนำให้ผู้คนรู้จัก LORIS บริบทวิทยาศาสตร์ที่เปิดกว้าง และกรณีการใช้งานที่เกี่ยวข้องกับสื่อรูปแบบต่างๆ
6. ไทม์ไลน์
การเชื่อมโยงชุมชน (17 สิงหาคม - 13 กันยายน) ก) ทำความคุ้นเคยกับซอฟต์แวร์ LORIS และเวิร์กโฟลว์ของทีม ข) ตรวจสอบ อัปเดต และปรับปรุงเอกสารประกอบการติดตั้ง/ตั้งค่า LORIS
สัปดาห์ที่ 1 (14 กันยายน - 20 กันยายน) อัปเดตและย้ายข้อมูลเอกสาร LORIS จาก GitHub wiki ไปอ่านเอกสาร
สัปดาห์ที่ 2 (21 กันยายน - 27 กันยายน) ก) ทบทวนเนื้อหาปัจจุบันสำหรับผู้ใช้ปลายทาง LORIS ข) เริ่มอุดช่องโหว่ในเนื้อหาสำหรับผู้ใช้ปลายทางของ LORIS ซึ่งให้การฝึกอบรมสำหรับผู้ใช้ใหม่ตามเอกสารประกอบปัจจุบัน
สัปดาห์ที่ 3 (28 กันยายน - 4 ตุลาคม) เติมเต็มช่องว่างในการเติมเต็มเนื้อหาสำหรับผู้ใช้ปลายทางของ LORIS ซึ่งให้การฝึกอบรมสำหรับผู้ใช้รายใหม่
สัปดาห์ที่ 4 (5 ตุลาคม - 11 ตุลาคม) ก) ทำความเข้าใจสถาปัตยกรรมฐานข้อมูล LORIS ในปัจจุบัน b) เริ่มนำแผนภาพฐานข้อมูลสำหรับแพลตฟอร์ม LORIS ไปใช้
สัปดาห์ที่ 5 (12 ตุลาคม - 18 ตุลาคม) ก) ทำงานการสร้างแผนภาพฐานข้อมูล LORIS ให้เสร็จสิ้น ข) ตรวจสอบ LORIS API ปัจจุบันและเริ่มช่วยปรับปรุงเอกสารประกอบของ API
สัปดาห์ที่ 6 (19 ตุลาคม - 25 ตุลาคม) ดำเนินการปรับปรุงเอกสาร LORIS API ต่อไป
สัปดาห์ที่ 7 (26 ตุลาคม - 1 พฤศจิกายน) ปรับปรุงเอกสารประกอบ LORIS API ให้เสร็จสิ้น
สัปดาห์ที่ 8 (2 พฤศจิกายน - 8 พฤศจิกายน) ทบทวนเนื้อหาปัจจุบันที่แนะนำผู้คนให้รู้จัก LORIS และเริ่มอัปเดตและปรับปรุงบริบททางวิทยาศาสตร์ที่เปิดกว้าง
สัปดาห์ที่ 9 (9 พฤศจิกายน - 15 พฤศจิกายน) อัปเดตให้เสร็จสิ้นและปรับปรุงบริบททางวิทยาศาสตร์แบบเปิดในเนื้อหาแนะนำผู้คนให้รู้จัก LORIS
สัปดาห์ที่ 10 (16 - 22 พฤศจิกายน) ช่วยอัปเดตและปรับปรุง Use Case บางส่วนในเนื้อหาที่แนะนำให้ผู้คนรู้จัก LORIS
สัปดาห์ที่ 11 (23-29 พฤศจิกายน) ดำเนินการอัปเดตและปรับปรุง Use Case ทั้งหมดในเนื้อหาที่แนะนำให้ผู้ใช้ LORIS ให้เสร็จสิ้น
การสรุปผลโปรเจ็กต์ (30 พฤศจิกายน - 5 ธันวาคม) ก) ล้างข้อมูลในเอกสารประกอบทั้งหมดที่ฉันสร้างขึ้น b) ผสานคำขอพุลที่สร้างขึ้นทั้งหมดใน GitHub และปิดปัญหาทั้งหมดที่ฉันสร้าง ค) ทำรายงานโปรเจ็กต์ขั้นสุดท้ายให้เสร็จและส่งรายงานไปยัง Google
7. สิ่งที่จะส่งมอบในอนาคต
หลังสิ้นสุดการใช้งาน Google ซีซันของเอกสาร 2020 แล้ว ฉันต้องการมอบเอกสารประกอบสำหรับ LORIS ต่อไป ฉันอยากพูดคุยกับนักพัฒนาซอฟต์แวร์ LORIS เป็นพิเศษเกี่ยวกับความเป็นไปได้ที่จะอัปเดตและสร้างเอกสารประกอบสำหรับผลงานใหม่ๆ ต่อไป นอกจากนี้ ฉันอยากจะใช้เวลาสักครู่เพื่อตรวจสอบเอกสารที่ได้สร้างขึ้นระหว่างโปรเจ็กต์ Google Season of Docs และตรวจดูว่ามีพื้นที่ที่ต้องปรับปรุงเพิ่มเติมหรือไม่ สุดท้ายนี้ เนื่องจากฉันมีพื้นฐานด้านวิศวกรรมที่เกี่ยวข้อง ฉันจึงพร้อมที่จะมีส่วนร่วมในด้านอื่นๆ ของซอฟต์แวร์ LORIS ในอนาคต เช่น การพัฒนาซอฟต์แวร์