หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- มูลนิธิโอเพนซอร์ส Geospatial Foundation
- ผู้เขียนด้านเทคนิค:
- flicstar
- ชื่อโปรเจ็กต์:
- ดูการเริ่มต้น OSGeoLive อย่างรวดเร็ว
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
วัตถุประสงค์
- อัปเดตเอกสารเพื่อให้เป็นปัจจุบัน ถูกต้อง และมีความเกี่ยวข้องอยู่เสมอ
- สร้างเทมเพลตเพื่อให้มีความสอดคล้องกันในเอกสารต่างๆ และสำหรับ Quickstarts ใหม่ที่เพิ่มเข้ามาในอนาคต
ผู้ชม
- ผู้ใช้ใหม่ของ OSGeo ที่เผยแพร่
- ผู้เขียน OSGeo Live Quickstarts ใหม่
บริการจัดส่ง
- Wiki
นี่คือสิ่งที่ฉันคิดว่าต้องทำให้เสร็จ
- ตรวจสอบ OSGeo Live Quickstarts ที่มีอยู่ 50 แบบ
- มาร์กอัปด้วยการแก้ไข ส่งเพื่อตรวจสอบ
- นำรีวิว/ความคิดเห็นไปใช้
- สร้างเทมเพลตการเริ่มต้นอย่างรวดเร็วเพื่อปรับใช้ความสม่ำเสมอในอนาคต
- อัปเดต "วิธีทํากระบวนการเริ่มต้นอย่างรวดเร็ว"
- เพิ่มแอปใหม่ลงใน OSGeoLive แอปเหล่านี้จำเป็นต้องมีการเริ่มต้นอย่างรวดเร็ว
สิ่งที่ฉันเสนอให้ทำ:
อ่านคู่มือเริ่มใช้งาน OSGeo Live อย่างรวดเร็ว 50 อย่างที่มีอยู่และมาร์กอัปการแก้ไข โดยใช้หน้าเหล่านี้เป็นข้อมูลอ้างอิง
ใหม่: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file
เก่า: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation
สร้างปัญหาด้านเอกสารประกอบใน Trac (เครื่องมือติดตามปัญหา)
ส่งรายงานแบบสรุปผลลัพธ์ เช่น เปอร์เซ็นต์ของ 50 รายการที่ต้องทำงานเพียงเล็กน้อย ปานกลาง หรือมาก
สร้างเทมเพลตการเริ่มต้นอย่างรวดเร็วเพื่อปรับใช้ความสม่ำเสมอในอนาคต
อัปเดตหน้า 'วิธีการบันทึกไฟล์การเริ่มต้นอย่างรวดเร็ว'
สิ่งที่คุณจะได้รับในตอนท้ายของ SoD มีดังนี้
- ตั๋วเอกสารในรถเข็น 50 ใบ พร้อมทำเครื่องหมายว่า "การเริ่มต้นใช้งานด่วน" ตามเทมเพลต Quickstart ที่ตกลงไว้
- ภาพรวมเกี่ยวกับสถานะปัจจุบันของ OSGeo Live Quickstarts และปริมาณงานที่ต้องทำในการอัปเดต
- เทมเพลตการเริ่มต้นอย่างรวดเร็วที่อัปเดตซึ่งสอดคล้องกับเทมเพลตคู่มือการฝึกอบรม
- กระบวนการจัดทำเอกสาร Quickstart ที่อัปเดต
ฉันจะเริ่มจากที่ใด:
- ดูสเปรดชีตแพ็กเกจ OSGeo-Live เพื่อดูว่ามีแพ็กเกจใดมีการเปลี่ยนแปลงไปในรุ่นต่างๆ
- สอบถามรายชื่ออีเมล OSGEo Live ว่ามีคำแนะนำสำหรับการเริ่มต้นอย่างรวดเร็วที่เจาะจงหรือไม่
สิ่งที่ฉันทำไปแล้ว:
- ตั้งค่า VM และ OSGeoLive ที่ติดตั้ง
- แยกที่เก็บเอกสาร OSGeoLive
- สามารถเข้าถึงไฟล์เอกสารได้และทบทวนตั๋วเอกสารที่มีอยู่แล้ว ตั๋ว #1382 มีความเกี่ยวข้อง: https://trac.osgeo.org/osgeolive/ticket/1382
- เข้าร่วมการสนทนาเกี่ยวกับรายชื่ออีเมล
- ใช้วิดีโอแชทแบบเป็นทางการ 2-3 รายการ