หน้านี้มีรายละเอียดของโครงการเขียนเชิงเทคนิคที่ยอมรับใน 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 ปีที่ผ่านมา ฉันได้เข้าร่วมโครงการทางเทคนิคหลายโครงการและได้พัฒนาทักษะการเขียนเชิงเทคนิคมาอย่างยาวนาน โดยเฉพาะอย่างยิ่ง ฉันรับผิดชอบการเขียนเอกสารในโครงการต่างๆ ของทีมที่ผ่านมาและเชื่อว่ามีประสบการณ์เพียงพอในด้านการใช้เครื่องมือเขียนเชิงเทคนิค เช่น อ่านเอกสาร, 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 ในปัจจุบัน ข) เริ่มใช้งานแผนภาพฐานข้อมูลสำหรับแพลตฟอร์ม 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 พฤศจิกายน) ช่วยอัปเดตและปรับปรุงกรณีการใช้งานบางส่วนในเนื้อหาที่แนะนำให้ผู้ใช้รู้จัก LORIS
สัปดาห์ที่ 11 (23-29 พฤศจิกายน) อัปเดตและปรับปรุง Use Case ทั้งหมดในเนื้อหาที่แนะนำให้ผู้คนรู้จัก LORIS ให้เสร็จสิ้น
การสรุปผลโปรเจ็กต์ (30 พฤศจิกายน - 5 ธันวาคม) ก) ล้างการมีส่วนร่วมในเอกสารทั้งหมดที่ฉันสร้าง ข) รวมคำขอพุลที่สร้างขึ้นทั้งหมดใน GitHub และปิดปัญหาทั้งหมดที่ฉันสร้าง ค) ทำรายงานโปรเจ็กต์ขั้นสุดท้ายให้เสร็จและส่งรายงานไปยัง Google
7. สิ่งที่ส่งมอบในอนาคต
หลังจากหมดฤดูกาลแห่ง Google เอกสารปี 2020 ฉันอยากจะมีส่วนร่วมในเอกสารประกอบสำหรับ LORIS ต่อ โดยเฉพาะอย่างยิ่ง เราอยากพูดคุยกับนักพัฒนาแอป LORIS เกี่ยวกับความเป็นไปได้ในการอัปเดตและสร้างเอกสารประกอบสำหรับผลงานใหม่ๆ ต่อไป นอกจากนี้ ฉันอยากจะใช้เวลาสักครู่เพื่อตรวจดูเอกสารประกอบที่ฉันสร้างไว้ในโปรเจ็กต์ Google Season of Docs แล้วดูว่ามีพื้นที่ให้ปรับปรุงอีกไหม สุดท้ายนี้ เนื่องจากเรามีพื้นฐานด้านวิศวกรรมศาสตร์ที่เกี่ยวข้อง ฉันจึงยินดีที่จะช่วยเหลือในด้านอื่นๆ ของซอฟต์แวร์ LORIS ในอนาคต เช่น การพัฒนาซอฟต์แวร์