หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- CERN-HSF
- นักเขียนเชิงเทคนิค
- LuckInTheRain
- ชื่อโปรเจ็กต์:
- การขยายและปรับปรุงเอกสารประกอบของ ROOT
- ระยะเวลาของโปรเจ็กต์
- ดำเนินงานมาอย่างยาวนาน (5 เดือน)
คำอธิบายโปรเจ็กต์
โครงการนี้มีเป้าหมายในการปรับปรุงเอกสารประกอบเกี่ยวกับ ROOT ซึ่งเป็นระบบซอฟต์แวร์หลักสำหรับการวิเคราะห์ข้อมูลและการนำเสนอข้อมูลที่ใช้โดยชุมชนฟิสิกส์พลังงานสูงทั่วโลก
นอกจากทักษะด้านเทคนิคสำหรับนักเขียนที่เราสามารถมอบให้ได้กับโครงการแล้ว ฉันก็คุ้นเคยกับ ROOT (6 และ 7) ด้วย และฉันมีความรู้เกี่ยวกับองค์ประกอบอื่นๆ ที่จำเป็นสำหรับโครงการ เช่น
- C++
- Python
- Git/GitHub
- เครื่องมือสร้างเว็บไซต์ (html, Markdown, Jekyll)
เราพบส่วนหลัก 3 ส่วนในเอกสารประกอบของ ROOT ดังนี้
- เว็บไซต์ https://root.cern
- คู่มืออ้างอิงคลาส C++ https://root.cern/doc/master/
- ฟอรัม https://root-forum.cern.ch
ฉันคิดว่าเอกสารรูท ("คู่มือ ROOT ใหม่") ต้องได้รับการปรับปรุงและเสริมในด้านต่อไปนี้
- เนื้อหาควรเข้าถึงและเข้าใจได้ง่ายขึ้นสำหรับผู้ที่ไม่ใช่นักฟิสิกส์โดยเฉพาะบทนำ
- เราจะพัฒนาบทแนะนำเพิ่มเติมที่อธิบายฟังก์ชันการทำงานทั่วไปของ ROOT
- หัวข้อและการพัฒนาใหม่ๆ บางรายการจะมีคำอธิบายและตัวอย่างโดยละเอียด
โดยตัวเลือกมีดังต่อไปนี้
- การเชื่อมโยง Python
- ไลบรารีคณิตศาสตร์
- คําอธิบายด้วยตนเองสําหรับเครื่องมือกราฟิกระดับสูง (TRatioPLot, THStack)
- เครื่องมือวิเคราะห์การขุดข้อมูลใหม่ (RDataFrame และ RNtuple)
- รูปแบบข้อมูลคีย์ใหม่ (RDataFrame และ RNtuple) ต้องใช้ข้อกำหนดทางเทคนิคและบทแนะนำโดยละเอียด
คำตอบสำหรับคำถามสำคัญจากผู้ใช้ เช่น คำถามที่โพสต์ในฟอรัม ROOT จะต้องรวมอยู่ในเอกสารประกอบ ซึ่งต้องใช้การวิเคราะห์คำถามที่พบบ่อยที่สุดอย่างละเอียด ตามด้วยช่วงการสังเคราะห์เพื่อแปลคำถามเหล่านั้นเป็นเอกสารประกอบใน "คู่มือ ROOT" ฉบับใหม่หรือในบทแนะนำใหม่ในคู่มืออ้างอิง
บทแนะนำแสดงฟังก์ชันการทำงานของ ROOT 7
- ฮิสโตแกรม ROOT 7 ใหม่
- กราฟิก ROOT 7 ใหม่
กำหนดเวลาโดยประมาณ (5 เดือน)
- ระยะที่ 1: การกำหนดงานและขอบเขตสำหรับเอกสารประกอบและบทแนะนำของ ROOT: 2 สัปดาห์
- ระยะที่ 2: รวบรวมและวิเคราะห์คําถามที่สําคัญของผู้ใช้จากฟอรัม ROOT: 2 สัปดาห์
- ระยะที่ 3: เขียนเอกสารประกอบ ROOT: 8 สัปดาห์
- ระยะที่ 4: พัฒนาบทแนะนำ: 8 สัปดาห์
สุดท้ายนี้ เราขอแจ้งให้ทราบว่าเราได้มีส่วนร่วมในเอกสารประกอบของ ROOT เมื่อปีที่แล้วด้วยโปรเจ็กต์ Google Season of Docs ระยะยาว ฉันได้กําหนดโครงสร้างใหม่ของคู่มือ ข้อเสนอนี้ในปีนี้จะเป็นส่วนสำคัญในการทำให้เอกสารประกอบอื่นๆ ที่ยังคงขาดหายไปใน ROOT สมบูรณ์