หน้านี้มีรายละเอียดโครงการงานเขียนเชิงเทคนิคที่ได้รับการยอมรับใน Google Season of เอกสาร
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- ScummVM
- นักเขียนเชิงเทคนิค
- Cadi
- ชื่อโปรเจ็กต์:
- เปิดพอร์ทัลเอกสาร
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
วัตถุประสงค์:
- เพื่อสร้างเอกสารประกอบสำหรับผู้ใช้ปลายทางที่มีเวอร์ชันคุณภาพสูงโดยการรวมข้อมูลจำนวนมากจากแหล่งที่มาที่แตกต่างกัน และเขียนข้อมูลใหม่เพื่อให้ชัดเจน สอดคล้อง และสมบูรณ์
- เอกสารประกอบควรเข้าใจง่ายสำหรับผู้เริ่มต้น โดยไม่ทำให้ผู้ใช้ที่เชี่ยวชาญด้านเทคโนโลยีรู้สึกถูกดูถูก
- วิธีสร้างพอร์ทัลเอกสารประกอบโดยใช้เครื่องมือสร้างเว็บไซต์แบบคงที่
- เพื่อจัดทำเอกสารประกอบสำหรับผู้ใช้ปลายทางที่ใช้งานได้ในอนาคตด้วยการสร้างเทมเพลตและวิธีการโดยละเอียดสำหรับผู้มีส่วนร่วมในโอเพนซอร์สในอนาคต
สถานการณ์ปัจจุบัน
- เอกสาร ScummVM ที่มีอยู่เผยแพร่อยู่ในหลายแหล่งที่มา
- ข้อมูลหายากและมักซ้ำกัน ทำให้ผู้ใช้สับสนได้ง่ายในหน้าเว็บที่คลุมเครือ
- ผู้ใช้ไม่ทราบข้อมูลใดที่เป็นปัจจุบันและข้อมูลใดล้าสมัย
- ข้อมูลบางอย่างขาดหายไปหรือไม่สมบูรณ์
การแก้ปัญหา
โครงสร้างเอกสารที่แนะนำ
หน้า Landing Page
|-- การเริ่มต้นใช้งาน
| -- Quick start guide
|-- Installing ScummVM
| |-- Nintendo 3DS
| |-- AmigaOS
| |-- Android
| |-- (every)
| |-- (common)
| |-- (supported)
|-- (แพลตฟอร์ม)
|-- การใช้ ScummVM
| |-- ตัวเปิดใช้
| |-- การตั้งค่าส่วนกลาง
| |-- การตั้งค่าเกม
| -- Keyboard shortcuts
|-- Advanced options
| |-- Cloud and LAN
| |-- Control Mapping
| |-- Configuration
| |-- Command line options
| |-- Graphics
|-- เพลงและเสียง
|-- ความช่วยเหลือ
| |-- คําถามที่พบบ่อย
| |-- รายชื่อติดต่อ
| |-- ปัญหาที่ทราบแล้ว
| -- Reporting a bug
|-- Game Notes-- หมายเหตุการเผยแพร่
- วิธีการเริ่มต้นใช้งาน
ผู้ใช้ใหม่มักมองหาคู่มือเริ่มต้นใช้งานฉบับย่อเพื่อเริ่มต้นใช้งานโดยเร็วที่สุด แม้ว่าการติดตั้ง ScummVM อาจมีความซับซ้อนในบางแพลตฟอร์ม แต่การติดตั้งลงในคอมพิวเตอร์ไม่สามารถทำได้
คู่มือการเริ่มต้นใช้งานฉบับย่อควรครอบคลุมข้อมูลต่อไปนี้
- วิธีติดตั้ง ScummVM ใน Windows, Mac และ Linux
วิธีโหลด เพิ่ม และเปิดเกม
การติดตั้ง ScummVM
ในกรณีที่การติดตั้งไม่ตรงไปตรงมา หรือในกรณีที่ผู้ใช้อาจไม่มีพื้นฐานทางเทคนิคที่แน่นหนา ผู้ใช้จะต้องมีคำแนะนำที่ครอบคลุมสำหรับการติดตั้ง ScummVM ในแพลตฟอร์มที่รองรับ
หน้าการติดตั้งที่ครอบคลุมแต่ละหน้าควรครอบคลุมข้อมูลต่อไปนี้
- ข้อกำหนด/ข้อกําหนดเบื้องต้นของระบบ
- วิธีดาวน์โหลด ScummVM เวอร์ชันที่เหมาะสม
- วิธีติดตั้ง ScummVM
- วิธีโหลดเกมลงในแพลตฟอร์มที่เลือก โดยเฉพาะอย่างยิ่งในกรณีที่ไม่ใช่แพลตฟอร์มที่เกมออกแบบมาเพื่อแพลตฟอร์มนั้น
วิธีเปิด ScummVM, เพิ่มเกม และเปิดเกม
การใช้ ScummVM
ผู้ใช้ต้องการเอกสารอ้างอิงที่อธิบายวิธีใช้ ScummVM
เอกสารอ้างอิงควรครอบคลุมข้อมูลต่อไปนี้
- อินเทอร์เฟซของ Launcher, ลักษณะของหน้าต่างและแท็บแต่ละรายการ รวมถึงวิธีการทำงานของหน้าต่างและแท็บ
- คำอธิบายของการตั้งค่าที่มีอยู่ ทั้งส่วนกลางและเฉพาะเกม
แป้นพิมพ์ลัด/แป้นพิมพ์ลัด
ตัวเลือกขั้นสูง:
ผู้ใช้ขั้นสูงต้องการข้อมูลเพิ่มเติมทางเทคนิคเกี่ยวกับตัวเลือกที่มีให้เพื่อปรับแต่งวิธีการทำงานของเกม
- หมายเหตุการแข่งขัน
ข้อมูลเฉพาะเกมที่ผู้ใช้จำเป็นต้องทราบ ซึ่งรวมถึงแต่ไม่จำกัดเพียงข้อมูลต่อไปนี้ - ลักษณะเฉพาะของการติดตั้ง - ไฟล์เพิ่มเติมที่จำเป็นต้องใช้ - การควบคุมที่ผิดปกติหรือแตกต่างจากปกติ
- ปัญหาที่ทราบ
ส่วนนี้ควรมีข้อบกพร่องที่ทราบซึ่งเกี่ยวข้องกับรุ่นนั้นๆ โดยเฉพาะ
- บันทึกประจำรุ่น
แม้ว่าเอกสารประกอบจะมีเวอร์ชัน แต่การมีส่วนบันทึกประจำรุ่นอาจเป็นประโยชน์ในการสรุปการเปลี่ยนแปลงในรุ่นล่าสุด ซึ่งอาจรวมถึงบางหัวข้อที่อยู่นอกขอบเขตของเอกสารประกอบนี้ เช่น เกมที่รองรับใหม่หรือข้อมูลเกี่ยวกับเครื่องมือใหม่
แผนโจมตี
เราขอแนะนำให้เริ่มต้นด้วยการสร้างเทมเพลตสำหรับหน้าการติดตั้ง ScummVM เนื่องจากเป็นวิธีที่ง่ายที่สุดในการรับข้อมูลที่ฉันต้องการจากผู้ดูแล/นักพัฒนาพอร์ต (โดยเฉพาะในกรณีที่มีข้อมูลนี้ไม่มากนักหรือไม่มีเลย) เราจะกรอกข้อมูลที่มีอยู่แล้วจากเอกสารที่มีอยู่ล่วงหน้า จากนั้นจะตรวจสอบความครบถ้วน ความถูกต้อง และสกุลเงิน หรือจะเพิ่มข้อมูลตามความจำเป็นก็ได้
ต่อไปเราจะตรวจสอบเอกสารประกอบที่มีอยู่ เช่น README, Wiki และเว็บไซต์ เมื่อทำไปแล้ว ฉันจะเขียนใหม่และเพิ่มไปยังแต่ละส่วนตามที่จำเป็น จากนั้นจะดึงข้อมูลทั้งหมดไปไว้ในพอร์ทัลใหม่ เราจะจดบันทึกข้อมูลที่จะดึงมาจากที่ใดด้วย เพื่อให้มั่นใจว่าเมื่อพอร์ทัลเผยแพร่แล้วจะไม่มีข้อมูลซ้ำกัน ขัดแย้งกัน หรือมีความผิดปกติอื่นๆ
ตลอดทุกขั้นตอน เราจะประสานงานกับที่ปรึกษา นักพัฒนาซอฟต์แวร์ ผู้ดูแลท่าเรือ และผู้เชี่ยวชาญเฉพาะด้านอื่นๆ เพื่อค้นหาข้อมูลที่ขาดหายไป รวมทั้งตรวจสอบว่าแต่ละหน้ามีข้อมูลล่าสุดและครบถ้วนสมบูรณ์ที่สุดเท่าที่จะเป็นไปได้
เราต้องการทำให้ชุมชน ScummVM เข้าถึงพอร์ทัลงานที่กำลังดำเนินการได้ตลอดกระบวนการเขียน เพื่อให้ได้รับความคิดเห็นแบบเรียลไทม์และตรวจสอบว่าไม่มีสิ่งใดตกหล่นระหว่างทาง ทั้งนี้เพื่อให้เป็นไปตามแนวคิดการทำงานร่วมกันและขึ้นอยู่กับการอนุมัติจากพี่เลี้ยง
เราขอแนะนำให้ใช้คู่มือสไตล์ เช่น คู่มือสไตล์ของเอกสารประกอบสำหรับนักพัฒนาซอฟต์แวร์ Google เพื่อให้เนื้อหานี้และเอกสารประกอบทั้งหมดสอดคล้องกันนับจากนี้ไป
เราจะใช้ภาพหน้าจอ, GIF และสื่อการสอนอื่นๆ เพื่อช่วยในการอธิบายให้เข้าใจได้ง่ายขึ้น
ไทม์ไลน์ที่เสนอ
กิจกรรมสานสัมพันธ์ในชุมชน 17 สิงหาคม - 13 กันยายน 2020
ใช้เวลาพูดคุยกับที่ปรึกษาและชุมชน ScummVM ในวงกว้างเพื่อปรับแต่งวิสัยทัศน์ของโครงการและสรุปรายละเอียด เช่น โครงสร้างเอกสารและเนื้อหา
สัปดาห์ที่ 1 14 - 20 กันยายน
- สร้างเทมเพลตสำหรับหน้าการติดตั้งเฉพาะแพลตฟอร์ม
- กรอกข้อมูลที่มีอยู่ลงในเทมเพลตล่วงหน้า แล้วส่งต่อให้ผู้ดูแล/นักพัฒนาพอร์ตที่เกี่ยวข้องเพื่อขอข้อมูลเพิ่มเติม
สัปดาห์ที่ 2 21 กันยายน - 27 กันยายน
- ตั้งค่าพอร์ทัลเอกสารประกอบใหม่
สัปดาห์ที่ 3 28 กันยายน - 4 ตุลาคม
การใช้ ScummVM - อินเทอร์เฟซ - การตั้งค่าส่วนกลาง การติดตั้ง ScummVM - คู่มือการติดตั้งสำหรับแพลตฟอร์มที่เฉพาะเจาะจงเมื่อส่งเทมเพลตที่เสร็จสมบูรณ์กลับมาให้เรา
สัปดาห์ที่ 4 5 ตุลาคม - 11 ตุลาคม
การใช้ ScummVM: - การตั้งค่าเกม - แป้นพิมพ์ลัด การติดตั้ง ScummVM: - คู่มือการติดตั้งเฉพาะแพลตฟอร์มเป็นเทมเพลตที่สมบูรณ์ถูกส่งกลับมาให้ฉัน
สัปดาห์ที่ 5 12-18 ตุลาคม
ตัวเลือกขั้นสูง: - คลาวด์และ LAN - การแมปการควบคุม การติดตั้ง ScummVM: - คู่มือการติดตั้งสำหรับแพลตฟอร์มที่เฉพาะเจาะจงเมื่อส่งเทมเพลตที่เสร็จสมบูรณ์กลับมาให้เรา
สัปดาห์ที่ 6 19 ตุลาคม - 25 ตุลาคม
ตัวเลือกขั้นสูง: - การกําหนดค่า - ตัวเลือกบรรทัดคําสั่ง การติดตั้ง ScummVM: - คู่มือการติดตั้งเฉพาะแพลตฟอร์มเมื่อส่งเทมเพลตที่เสร็จสมบูรณ์กลับมาให้เรา
สัปดาห์ที่ 7 26 ตุลาคม - 1 พฤศจิกายน
ตัวเลือกขั้นสูง: - กราฟิก - เสียง การติดตั้ง ScummVM: - คู่มือการติดตั้งสำหรับแพลตฟอร์มที่เฉพาะเจาะจงเมื่อคุณส่งเทมเพลตที่เสร็จสมบูรณ์กลับมาให้เรา
สัปดาห์ที่ 8 2-8 พฤศจิกายน
ความช่วยเหลือ: - คําถามที่พบบ่อย - รายชื่อติดต่อ - ปัญหาที่ทราบ
การติดตั้ง ScummVM - คู่มือการติดตั้งสำหรับแพลตฟอร์มที่เฉพาะเจาะจงเมื่อส่งเทมเพลตที่เสร็จสมบูรณ์กลับมาให้เรา
สัปดาห์ที่ 9 9 - 15 พฤศจิกายน
ความช่วยเหลือ: - การรายงานข้อบกพร่อง - หมายเหตุเกี่ยวกับเกม - บันทึกประจำรุ่น
การติดตั้ง ScummVM: - ดำเนินการขั้นสุดท้ายของคำแนะนำแพลตฟอร์มที่ยังไม่เสร็จสมบูรณ์
สัปดาห์ที่ 10 16 พฤศจิกายน - 22 พฤศจิกายน
- แก้ไข พิสูจน์อักษร และตัดสินใจขั้นสุดท้ายเกี่ยวกับพอร์ทัล เช่น การนำทางแถบด้านข้าง การปรับธีม/CSS ฯลฯ
- ตรวจสอบว่าลิงก์ทั้งหมดทำงานได้ตามที่คาดไว้
- ตรวจสอบว่ารูปภาพ/ภาพเคลื่อนไหวแสดงอย่างถูกต้อง
สัปดาห์ที่ 11 23 - 30 พฤศจิกายน
- ดำเนินการกับรายการที่ยังไม่ได้ดำเนินการให้เสร็จสมบูรณ์และเปิดตัวพอร์ทัลอย่างเป็นทางการ
- เมื่อเปิดพอร์ทัลแล้ว ให้นำข้อมูลที่ซ้ำซ้อนออกจากแหล่งข้อมูลอื่นๆ ตามการให้คำปรึกษากับที่ปรึกษา