หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- Open Source Geospatial Foundation
- นักเขียนเชิงเทคนิค
- flicstar
- ชื่อโปรเจ็กต์:
- ดูการเริ่มต้น OSGeoLive อย่างรวดเร็ว
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
วัตถุประสงค์
- อัปเดตเอกสารให้เป็นปัจจุบัน ถูกต้อง และมีความเกี่ยวข้อง
- สร้างเทมเพลตเพื่อให้มีความสอดคล้องกันทั่วทั้งเอกสาร และสำหรับ Quickstarts ใหม่ๆ ที่จะเพิ่มเข้ามาในอนาคต
ผู้ชม
- ผู้ใช้ใหม่ของ OSGeo Live
- ผู้เขียนคู่มือเริ่มต้นใช้งานฉบับย่อของ OSGeo Live เวอร์ชันใหม่
บริการจัดส่ง
- 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 ตั๋วเอกสารประกอบใน Trac พร้อมการไฮไลต์การเริ่มต้นใช้งานตามเทมเพลตการเริ่มต้นใช้งานที่ตกลงกันไว้
- ภาพรวมสถานะปัจจุบันของ OSGeo Live Quickstarts และปริมาณงานที่จําเป็นในการอัปเดต
- เทมเพลตเริ่มต้นใช้งานที่อัปเดตแล้วซึ่งสอดคล้องกับเทมเพลตคู่มือการฝึกอบรม
- กระบวนการเอกสารประกอบการเริ่มต้นใช้งานฉบับปรับปรุง
สิ่งที่เราจะเริ่มต้น
- ดูสเปรดชีตแพ็กเกจ OSGeo-Live เพื่อดูว่าแพ็กเกจใดมีการเปลี่ยนแปลงระหว่างรุ่น
- สอบถามรายชื่ออีเมลของ OSGeo Live ว่ามีข้อแนะนำในการเริ่มต้นใช้งานแบบด่วนที่เฉพาะเจาะจงหรือไม่
สิ่งที่เราดำเนินการไปแล้วมีดังนี้
- ตั้งค่า VM ของฉันและ OSGeoLive ที่ติดตั้ง
- แยกที่เก็บ OSGeoLive-Doc
- ได้รับสิทธิ์เข้าถึง trac และตรวจสอบคำขอแจ้งปัญหาเอกสารที่มีอยู่ ตั๋ว #1382 ดูเหมือนจะเกี่ยวข้อง: https://trac.osgeo.org/osgeolive/ticket/1382
- เข้าร่วมการสนทนาในรายชื่ออีเมล
- วิดีโอแชทแบบไม่เป็นทางการ 2-3 ครั้ง