หน้านี้มีรายละเอียดโครงการงานเขียนเชิงเทคนิคที่ได้รับการยอมรับใน Google Season of เอกสาร
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- CERN-HSF
- นักเขียนเชิงเทคนิค:
- LuckInTheRain
- ชื่อโปรเจ็กต์:
- เอกสารประกอบของ ROOT: การวิเคราะห์ การปรับโครงสร้าง และการเขียนใหม่
- ระยะเวลาของโปรเจ็กต์
- ดำเนินงานมาอย่างยาวนาน (5 เดือน)
คำอธิบายโปรเจ็กต์
โปรเจ็กต์นี้แบ่งออกเป็น 4 ระยะ ดังนี้
1.) กำลังวิเคราะห์เอกสารรูทปัจจุบัน
เอกสาร ROOT ที่สมบูรณ์ (เว็บไซต์, คู่มือผู้ใช้, เอกสารอ้างอิง C++, บทแนะนำ ฯลฯ) จะได้รับการวิเคราะห์และตรวจสอบตามเกณฑ์ต่อไปนี้ กล่าวคือ การกำหนดโครงสร้าง การแยกส่วน การกำหนดมาตรฐาน กลไกการเข้าถึง ความสอดคล้อง ประเภทข้อมูลที่ใช้ การเตรียมการเฉพาะกลุ่มเป้าหมายและความเข้าใจ โดยมีวัตถุประสงค์เพื่อสร้างแนวคิดสําหรับการจัดการข้อมูล ตารางสําหรับการจัดโครงสร้าง และหลักเกณฑ์ในการทำให้เนื้อหาเป็นมาตรฐาน
2.) กำหนดวิธีการในการจัดโครงสร้างเอกสารประกอบการเขียนด้วยทีม ROOT
DITA (Darwin Information Typing Architecture) ซึ่งเป็นมาตรฐาน OASIS สำหรับเอกสารประกอบซอฟต์แวร์ (https://www.oasis-open.org/committees/dita/) นำเสนอต่อทีม ROOT โดยมุ่งเน้นที่การทำความเข้าใจวิธีจัดโครงสร้างเนื้อหาเฉพาะซอฟต์แวร์ และวิธีใช้ประเภทข้อมูลพื้นฐาน เช่น "แนวคิด" "งาน" และ "ข้อมูลอ้างอิง" ในการเขียนเอกสารประกอบของซอฟต์แวร์
3.) การปรับโครงสร้างและการจัดระเบียบเอกสารประกอบ ROOT ใหม่
จากผลลัพธ์ของ 2 ขั้นตอนแรก เอกสารประกอบ ROOT ได้รับการปรับโครงสร้างและแบ่งเป็นโมดูลตามกลุ่มเป้าหมาย บทบาท และกรณีการใช้งาน และเนื้อหาจะได้รับมอบหมายให้กับองค์ประกอบที่เกี่ยวข้อง (เว็บไซต์ คู่มือผู้ใช้ ข้อมูลอ้างอิง C++ บทแนะนำ ฯลฯ) และประเภทเนื้อหา เนื่องจากข้อมูลที่มีอยู่นั้นกว้างมาก จึงต้องมีการสร้างโครงสร้างการอ้างอิงที่สอดคล้องกัน โดยมีวัตถุประสงค์เพื่อให้ภาพรวมที่ครอบคลุมและแสดงวิธีที่ชัดเจนแก่ผู้ใช้เกี่ยวกับวิธีใช้ ROOT เพื่อตอบสนองความต้องการ นอกจากนี้ยังมีบทนำแบบกระชับที่ไม่ได้มุ่งเน้นเรื่องฟิสิกส์
4.) การเขียนเอกสารประกอบ ROOT ขึ้นใหม่
เนื้อหาหลักของเอกสารประกอบ โดยเฉพาะคู่มือผู้ใช้ได้รับการเขียนขึ้นใหม่ตามแนวทาง DITA กฎการจัดโครงสร้างและการเขียนจะบันทึกไว้ในคู่มือสไตล์เพื่อให้เอกสารมีความสอดคล้องกันในอนาคต โดยมีเป้าหมายเพื่อให้ทีม ROOT ขยายและดูแลรักษาเอกสารประกอบ ROOT ด้วยตนเองในอนาคต
กำหนดเวลาโดยประมาณ (5 เดือน)
ระยะที่ 1: วิเคราะห์เอกสารประกอบ ROOT ปัจจุบัน: 3 สัปดาห์
ระยะที่ 2: กำหนดวิธีการในการจัดโครงสร้างเอกสารประกอบเกี่ยวกับซอฟต์แวร์การเขียนด้วยทีมรูท: 2 สัปดาห์
ระยะที่ 3: การปรับโครงสร้างและการจัดระเบียบเอกสารประกอบ ROOT: 4 สัปดาห์
ระยะที่ 4: เขียนเอกสารประกอบ ROOT ใหม่: 11 สัปดาห์