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