หน้านี้มีรายละเอียดของโครงการเขียนเชิงเทคนิคที่ยอมรับใน Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- CERN-HSF
- ผู้เขียนด้านเทคนิค:
- จอห์น
- ชื่อโปรเจ็กต์:
- CERN-HSF - เอกสารประกอบ ROOT สำหรับการนำไปใช้งานทั่วไป การเชื่อมโยง Python แบบไดนามิก และบทแนะนำ
- ระยะเวลาของโปรเจ็กต์:
- ระยะยาว (5 เดือน)
คำอธิบายโปรเจ็กต์
CERN-HSF - เอกสารประกอบ ROOT สำหรับการใช้บริการผู้ชมทั่วไป การเชื่อมโยง Python แบบไดนามิก และบทแนะนำ ที่ปรึกษา: Olivier Couet, Axel Nauman
บทคัดย่อ: เอกสารเป็นสิ่งสำคัญเพื่อให้ผู้ใช้ปรับใช้ซอฟต์แวร์ได้สำเร็จและมีประสิทธิภาพ เอกสารสำหรับผู้ใช้ที่ชัดเจน ถูกต้อง และครอบคลุมจะช่วยให้ผู้ใช้สามารถใช้ซอฟต์แวร์ได้อย่างชำนาญในการมุ่งสู่เป้าหมาย นอกจากนี้ ตัวอย่างและบทแนะนำที่อาจไม่เหมาะสมจะเป็นเครื่องมือที่มีประสิทธิภาพที่ช่วยให้ผู้ใช้เรียนรู้ได้อย่างรวดเร็ว
เมื่อเราตรวจสอบการใช้ ROOT ของนักฟิสิกส์ นักวิจัย และนักพัฒนาซอฟต์แวร์ภายในพื้นที่วิเคราะห์ข้อมูลและการแสดงข้อมูลผ่านภาพสำหรับฟิสิกส์ ผลก็คือประโยชน์ของเอกสารที่อัปเดตและใช้งานง่าย โดยเฉพาะอย่างยิ่ง จากความแพร่หลายของซอร์สโค้ดและการเติบโต ระบบเอกสารประกอบจึงได้ประโยชน์จากการพัฒนาไปพร้อมๆ กัน เพื่อให้ผู้ใช้สามารถใช้ประโยชน์จาก ROOT ทั้งหมดให้ได้
สรุปและการวิเคราะห์เอกสารปัจจุบัน ขณะนี้ เอกสารสำหรับผู้ใช้มีคำแนะนำที่ช่วยให้นักฟิสิกส์นำ ROOT ไปใช้ได้ง่ายขึ้นเมื่อเทียบกับผู้ชมทั่วไป นอกจากนี้ ในบางหัวข้อ เช่น การเชื่อมโยง Python แบบไดนามิก อาจมีการปรับปรุงเพื่อให้เอกสารมีความครอบคลุมและชัดเจนยิ่งขึ้น ในทำนองเดียวกัน RNTuple รูปแบบข้อมูลใหม่ยังขาดข้อมูลจำเพาะโดยละเอียดที่จำเป็น สุดท้ายนี้ เอกสารปัจจุบันยังไม่มีบทแนะนำที่เกี่ยวข้องกับ ROOT 7
ระเบียบวิธี: หลังจากปรึกษากับ Olivier ปรากฏว่าในการที่จะแก้ไขปัญหาที่กล่าวไปแล้ว จุดมุ่งเน้นหลักควรเกี่ยวข้องกับการระบุช่องว่างทางความรู้ระหว่างนักวิจัยเฉพาะทางและผู้ชมทั่วไป จัดทำเอกสารประกอบเพื่อเชื่อมโยงช่องว่างดังกล่าว เขียนเอกสารประกอบโดยละเอียดมากขึ้นเกี่ยวกับการเชื่อมโยง Python แบบไดนามิก การใช้ "บทแนะนำสำหรับการวิเคราะห์สมัยใหม่" สำหรับ ROOT 7 และสร้างข้อกำหนดทางเทคนิคโดยละเอียดสำหรับ RNTuple ในระหว่างขั้นตอนนี้ การจัดทำเอกสารอาจนำสมุดบันทึก Jupyter มาใช้เพื่อให้เครื่องมือการเรียนรู้แบบอินเทอร์แอกทีฟสามารถช่วยเหลือผู้ใช้ได้
ไทม์ไลน์: ขั้นตอนของโครงการประมาณดังนี้ ระบุช่องว่างทางความรู้ระหว่างนักวิจัยที่มีความเชี่ยวชาญเฉพาะทางและผู้ชมทั่วไป (ขณะอ่านเอกสารประกอบปัจจุบันและซอร์สโค้ด) → 1-2 สัปดาห์ สร้างและรีแฟคเตอร์เอกสารเพื่อเชื่อมโยงช่องว่างนั้น → 3 สัปดาห์ เขียนเอกสารประกอบโดยละเอียดเกี่ยวกับการเชื่อมโยง Python แบบไดนามิก → 3 สัปดาห์ ได้ทำบทแนะนำเกี่ยวกับการเชื่อมโยงโปรเจ็กต์ Python แบบไดนามิกแล้ว 3 สัปดาห์ ดูบทแนะนำสำหรับการติดตั้งใช้งานโปรเจ็กต์ Python แบบไดนามิก 3 สัปดาห์
ผลลัพธ์และคำแนะนำสู่ความสำเร็จ: เอกสารสำหรับผู้ใช้ที่รวมเป็นหนึ่งเดียวโดยไม่มีช่องว่าง เอกสารสำหรับผู้ใช้ที่อัปเดตอย่างสมบูรณ์เพื่อให้สอดคล้องกับฟีเจอร์ล่าสุด เช่น ชั้นเรียนใหม่ที่ได้รับ บทแนะนำผ่านสมุดบันทึกของ Jupyter