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