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