โครงการ INCF

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

สรุปโปรเจ็กต์

องค์กรโอเพนซอร์ส:
INCF
นักเขียนเชิงเทคนิค:
hq
ชื่อโปรเจ็กต์:
เอกสารการฝึกอบรม LORIS สำหรับประสาทวิทยาศาสตร์แบบเปิดที่ทำซ้ำได้
ระยะเวลาของโปรเจ็กต์
ใช้งานนาน (5 เดือน)

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

1. บทคัดย่อ

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

2. สถานะปัจจุบัน

ปัจจุบัน LORIS ใช้ Github Wiki, Read the Docs และเว็บไซต์ LORIS.ca เพื่อโฮสต์เอกสารประกอบทั้งหมด โดยเฉพาะอย่างยิ่ง LORIS GitHub Wiki โฮสต์เอกสารประกอบ LORIS มากที่สุด และบทแนะนำ งานนำเสนอ คู่มือผู้ใช้ และบทแนะนำ LORIS เพิ่มเติมจะโฮสต์ในแพลตฟอร์มต่างๆ เอกสารประกอบ LORIS ปัจจุบันมีคำแนะนำสำหรับนักพัฒนาซอฟต์แวร์และผู้ใช้ LORIS แต่อาจได้รับประโยชน์จากการพัฒนาและการจัดระเบียบเพิ่มเติม โดยเฉพาะการอัปเดตเอกสารประกอบและการปรับปรุงรายละเอียดทางเทคนิค

3. ประโยชน์ต่อชุมชน

การปรับปรุงเอกสารการฝึกอบรม LORIS สำหรับระบบประสาทเทียมแบบเปิดทำให้นักวิจัยและนักพัฒนาซอฟต์แวร์ได้รับประโยชน์จากเครื่องมือที่ใช้งานง่ายขึ้นเพื่อปรับปรุงการเก็บรวบรวมข้อมูลในการศึกษา กล่าวโดยละเอียดคือ โปรเจ็กต์อาจอัปเดตและปรับปรุงเอกสารประกอบการติดตั้ง/การตั้งค่า LORIS รวมถึงเนื้อหาสำหรับผู้ใช้ปลายทางที่ให้การฝึกอบรมแก่ผู้ใช้ใหม่ นอกจากนี้ โปรเจ็กต์นี้ยังมีเป้าหมายที่จะช่วยย้ายข้อมูลและอัปเดตเอกสารประกอบจากวิกิ GitHub ของ LORIS ไปยัง Read the Docs ในระหว่างนี้ โปรเจ็กต์อาจแสดงผังฐานข้อมูลเพื่อสื่อสารความสัมพันธ์ของข้อมูลและปรับปรุงการแสดงภาพสถาปัตยกรรม สุดท้าย โปรเจ็กต์นี้จะอัปเดตและปรับปรุงเนื้อหาที่แนะนำ LORIS, บริบทวิทยาศาสตร์แบบเปิด และกรณีการใช้งาน

4. จุดแข็งส่วนบุคคลสำหรับโปรเจ็กต์

ในช่วงหลายปีที่ผ่านมา ฉันได้เข้าร่วมโครงการทางเทคนิคหลายโครงการ ซึ่งได้พัฒนาภูมิหลังด้านการเขียนเชิงเทคนิคมาเป็นอย่างดี โดยเฉพาะอย่างยิ่ง ฉันรับผิดชอบการเขียนเอกสารประกอบในโปรเจ็กต์ของทีมหลายโปรเจ็กต์ที่ผ่านมา และเชื่อว่าตนเองมีประสบการณ์มากพอในการใช้เครื่องมือเขียนเชิงเทคนิค เช่น Read the Docs, Sphinx, Mkdocs, Markdown, LaTeX เป็นต้น นอกจากนี้ ประสบการณ์การสอนในหลักสูตร STEM ที่ผ่านมายังช่วยพัฒนาทักษะการสื่อสารทางเทคนิคของฉันด้วย เอกสารการฝึกอบรม LORIS สำหรับโปรเจ็กต์ประสาทวิทยาแบบเปิดที่ซ้ำได้กับ INCF เป็นโอกาสที่ดีสำหรับฉันในการใช้เทคนิคการเขียนเชิงเทคนิคกับ LORIS นอกจากนี้ ฉันยังสนใจด้านภาพถ่ายสมองเป็นอย่างมากและพยายามหาโอกาสที่จะนำความรู้ทางเทคนิคไปประยุกต์ใช้กับสาขานี้ เอกสารการฝึกอบรม LORIS สำหรับโปรเจ็กต์ประสาทวิทยาแบบเปิดที่ซ้ำได้กับ INCF จะเป็นประสบการณ์ที่มีคุณค่าสำหรับฉัน

ส่วนที่ 5 สิ่งที่ส่งมอบ

  1. ย้ายข้อมูลและอัปเดตเอกสารประกอบเกี่ยวกับ LORIS ปัจจุบัน
  2. ตรวจสอบ อัปเดต และปรับปรุงเอกสารประกอบการติดตั้ง/การตั้งค่า LORIS และเติมเต็มช่องว่างในเนื้อหาสำหรับผู้ใช้ปลายทางที่ให้บริการฝึกอบรมแก่ผู้ใช้ใหม่
  3. ช่วยสร้างแผนภาพฐานข้อมูลเพื่อสื่อสารความสัมพันธ์ของข้อมูล (เช่น เรื่อง การเข้าชมศึกษา) และปรับปรุงการแสดงข้อมูลผ่านภาพของสถาปัตยกรรม
  4. ช่วยกันอัปเดตและปรับปรุงเอกสารประกอบของ LORIS API
  5. ช่วยปรับปรุงและปรับปรุงเนื้อหาที่แนะนำให้ผู้คนรู้จัก 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 พฤศจิกายน) ช่วยอัปเดตและปรับปรุง Use Case บางส่วนในเนื้อหาที่แนะนำ LORIS ให้แก่ผู้ใช้

สัปดาห์ที่ 11 (23-29 พฤศจิกายน) อัปเดตและปรับปรุง Use Case ทั้งหมดในเนื้อหาที่แนะนำ LORIS ให้ผู้ใช้ทราบ

การทำให้โปรเจ็กต์เสร็จสมบูรณ์ (30 พฤศจิกายน - 5 ธันวาคม) ก) ล้างข้อมูลการมีส่วนร่วมในเอกสารประกอบทั้งหมดที่ฉันสร้างขึ้น ข) ผสานคำขอดึงข้อมูลทั้งหมดที่สร้างไว้ใน GitHub และปิดปัญหาทั้งหมดที่ฉันสร้างขึ้น ค) เขียนรายงานโปรเจ็กต์ฉบับสุดท้ายให้เสร็จสมบูรณ์และส่งรายงานไปยัง Google

7. สิ่งที่ส่งมอบในอนาคต

หลังจาก Google Season of Docs 2020 ฉันต้องการมีส่วนร่วมในเอกสารประกอบของ LORIS ต่อไป โดยเฉพาะอย่างยิ่ง เราต้องการพูดคุยกับนักพัฒนาซอฟต์แวร์ของ LORIS เกี่ยวกับความเป็นไปได้ในการอัปเดตและจัดทำเอกสารประกอบสำหรับการเปิดตัวใหม่ๆ ต่อไป นอกจากนี้ เราต้องการใช้เวลาเพิ่มเติมเพื่อตรวจสอบเอกสารประกอบที่ฉันสร้างในโปรเจ็กต์ Google Season of Docs และดูว่ายังมีจุดที่ควรปรับปรุงอีกไหม สุดท้ายนี้ เนื่องจากฉันมีพื้นฐานด้านวิศวกรรมที่เกี่ยวข้อง ฉันจึงยินดีที่จะช่วยเหลือในด้านอื่นๆ ของซอฟต์แวร์ LORIS ในอนาคต เช่น การพัฒนาซอฟต์แวร์