หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- Qubes OS
- นักเขียนเชิงเทคนิค
- c1e0
- ชื่อโปรเจ็กต์:
- รวมคู่มือการแก้ปัญหา
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ABSTRACT
คู่มือการแก้ไขปัญหาออกแบบมาเพื่อช่วยให้ผู้ใช้ปลายทางแก้ปัญหาที่พบเมื่อใช้ผลิตภัณฑ์หรือบริการ คู่มือการแก้ปัญหาที่ดีมีความสำคัญเนื่องจากจะช่วยผู้ใช้เมื่อเกิดปัญหา ช่วยป้องกันไม่ให้ผู้ใช้เลิกใช้ผลิตภัณฑ์เมื่อพบปัญหา Qubes มีผู้ใช้รายวันหลายพันคนทั่วโลก ซึ่งผู้ใช้จำนวนมากจะประสบปัญหาในบางเวลาและจะได้รับประโยชน์จากคู่มือการแก้ปัญหา
สถานะปัจจุบันของคู่มือแก้ปัญหา
ในขณะนี้ คำแนะนำการแก้ปัญหาของ QubesOS กระจัดกระจายอยู่ในหลายหน้าและบางครั้งก็ไม่สมบูรณ์ ทำให้ต้องโพสต์วิธีการเดิมซ้ำๆ เมื่อช่วยผู้ใช้ในการวินิจฉัยปัญหา คู่มือที่มีอยู่ไม่มีเลย์เอาต์อาการและการดำเนินการ ทำให้ผู้ใช้จับคู่ปัญหากับวิธีแก้ปัญหาได้ยาก นอกจากนี้ ยังมีปัญหาบางอย่างที่พูดถึงซ้ำๆ ในโซเชียลมีเดีย (Reddit), หน้าปัญหา Qubes ใน GitHub และในฟอรัม #qubes-users แต่ยังไม่ได้บันทึกไว้ในคู่มือการแก้ปัญหาฉบับปัจจุบัน
เหตุใดคู่มือการแก้ปัญหาที่เราเสนอจึงดีกว่าคู่มือที่มีอยู่
คำแนะนำในการแก้ปัญหาที่ฉันเสนอจะสมบูรณ์และได้รับการจัดโครงสร้างเพื่อให้แน่ใจว่ามีความถูกต้องและใช้งานง่าย คำแนะนำจะแสดงวิธีการที่สั้นกระชับซึ่งอธิบายวิธีแก้ปัญหาทีละขั้นตอน โดยจะมีเลย์เอาต์อาการและการดำเนินการ ซึ่งจะระบุปัญหาและแสดงวิธีแก้ปัญหาที่แนะนำ การแก้ปัญหาจะได้รับการจัดทำให้เหมาะกับเครื่องมือค้นหาและปรับคำให้คำนึงถึงปัญหาที่ผู้ใช้ค้นหาบนโซเชียลมีเดียและเครื่องมือค้นหา ทั้งหมดนี้จะช่วยให้ผู้ใช้ค้นหาคู่มือการแก้ปัญหาอย่างเป็นทางการผ่านเครื่องมือค้นหาและพบวิธีแก้ปัญหาได้อย่างรวดเร็วและง่ายดาย
โครงสร้างของคู่มือแก้ปัญหาที่เสนอและกรอบเวลา
เราได้สร้างโครงสร้างที่เสนอสำหรับคู่มือการแก้ปัญหา Qubes OS ซึ่งดูได้ที่นี่ https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing เลย์เอาต์จะมีกรอบเวลาโดยประมาณที่ใช้ในการเขียนแต่ละส่วนการแก้ปัญหา เราจะใช้เลย์เอาต์นี้หลังจากได้รับความคิดเห็นจากที่ปรึกษา โครงสร้างและกรอบเวลาอาจปรับเปลี่ยนตามความคิดเห็นของที่ปรึกษา
เป้าหมายโครงการ
- ปรับโครงสร้างคู่มือการแก้ปัญหาให้มีเลย์เอาต์อาการและการดำเนินการแบบรวมที่เข้าใจง่ายขึ้น
- เขียนขั้นตอนการแก้ปัญหาที่มีอยู่ใหม่ให้มีวิธีการทีละขั้นตอนที่เข้าใจง่าย
- เพิ่มภาพหน้าจอตามที่จำเป็น
- ติดตั้งและลองใช้ Qubes ด้วยตนเองและบันทึกปัญหาที่พบ ฉันมีคอมพิวเตอร์ 3 เครื่อง ได้แก่ Lenovo Thinkpad, Dell Latitude และ Acer Aspire เราจะลองใช้ Qubes ในคอมพิวเตอร์แต่ละเครื่องเหล่านี้ โดยบันทึกข้อผิดพลาดและตรวจสอบการแก้ปัญหา
- นำข้อมูลที่ล้าสมัยในคู่มือที่มีอยู่ออก
- ตรวจสอบว่าการแก้ปัญหาถูกต้อง ขณะนี้ คู่มือการแก้ปัญหาที่มีอยู่จะมีข้อความแสดงข้อผิดพลาดว่า "เอกสารนี้ไม่ใช่เอกสารอย่างเป็นทางการของบุคคลที่สาม โปรเจ็กต์ระบบปฏิบัติการ Qubes ไม่สามารถรับประกันความถูกต้องของหน้านี้ โปรดระมัดระวัง"" ระบบจะทิ้งคำเตือนนี้หลังจากยืนยันแล้วว่าวิธีการแก้ปัญหาถูกต้อง เราจะตรวจสอบความถูกต้องของวิธีการเหล่านี้ด้วยตนเองโดยการทดสอบการแก้ปัญหาใน PC (หากเป็นไปได้) หรือตรวจสอบทางออนไลน์ว่าผู้ใช้รายใดยืนยันวิธีการแก้ปัญหาดังกล่าวแล้ว
- ย้ายข้อมูลการแก้ปัญหาภายนอก (จากฟอรัมและ GitHub) ไปยังหน้าเว็บการแก้ปัญหาอย่างเป็นทางการ
- ค้นคว้าและค้นหาปัญหาเพิ่มเติมที่ผู้ใช้พบจากปัญหาจาก Reddit (r/QubesOS), Stack Exchange, #qubes-users Google Group และ GitHub นอกจากนี้ เราจะใช้เครื่องมือวิจัยคีย์เวิร์ดอย่าง Keywordtool.io และ UberSuggest.com เพื่อค้นหาคำถามที่มีการค้นหาบ่อยในเครื่องมือค้นหาอย่าง Google
- เพิ่มส่วน "รับความช่วยเหลือ" ในกรณีที่คู่มือการแก้ปัญหาไม่สามารถช่วยแก้ปัญหาของผู้ใช้ได้ ดูตัวอย่างได้ในหน้าการแก้ปัญหาของ Fedora ที่ https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help
ทำไมต้องมีโปรเจ็กต์นี้
ฉันหลงใหลในเทคโนโลยี โดยเฉพาะอย่างยิ่งการรักษาความมั่นคงปลอดภัยไซเบอร์และความเป็นส่วนตัว ฉันเชื่อว่าการเขียนเป็นหนึ่งในวิธีที่เหมาะกับตัวเองที่สุด ฉันสนใจระบบปฏิบัติการ Qubes เป็นพิเศษเพราะทับซ้อนกับความสนใจหลัก 2 อย่างของฉัน นั่นคือความปลอดภัยและความเป็นส่วนตัว ฉันเป็นผู้ใช้ผลิตภัณฑ์อื่นๆ ที่เน้นความปลอดภัยและความเป็นส่วนตัว เช่น DuckDuckGo และ Tor เราเพิ่งค้นพบ Qubes OS เมื่อเร็วๆ นี้และชอบระบบปฏิบัติการนี้มาก
เหตุผลที่ฉันคิดว่าฉันเหมาะสมกับโปรเจ็กต์นี้
- ฉันรักความปลอดภัย ความเป็นส่วนตัว และการเขียนเอกสารที่ดี/เป็นประโยชน์
- เนื่องจากเราเคยพบปัญหาในการติดตั้งและใช้งาน Qubes OS เราจึงสามารถอธิบายปัญหาเหล่านี้ได้ดีขึ้นในวิธีการแก้ปัญหา
- ในช่วงเดือนที่ผ่านมา เราได้ศึกษาด้านเทคนิคของระบบปฏิบัติการ Qubes เรายังได้ศึกษาเอกสารประกอบของ Qubes OS อย่างละเอียดแล้ว เราได้สร้างคำขอดึงข้อมูล (https://github.com/QubesOS/qubes-doc/pull/1005/files) เพื่อลองทำความเข้าใจกระบวนการแก้ไขเอกสาร
- ฉันเพิ่งฝึกงานที่โปรเจ็กต์ Tor เมื่อเร็วๆ นี้ บทบาทของฉันคือการสนับสนุนด้านเทคนิคและการเขียน ขณะที่ทำงานที่แผนกช่วยเหลือ ฉันได้รับคำถามหลายร้อยข้อจากผู้ใช้ที่ประสบปัญหาในการติดตั้งหรือใช้เบราว์เซอร์ Tor การช่วยเหลือผู้ใช้เหล่านี้แก้ปัญหาทำให้ฉันได้เรียนรู้วิธีเขียนวิธีการแก้ปัญหาที่กระชับและเข้าใจง่าย
- ขณะทำงานที่ Tor Project ฉันยังเขียนเอกสารทางเทคนิคโดยใช้มาร์กดาวน์ด้วย ฉันใช้ Git, GitHub และ GitLab สำหรับการควบคุมเวอร์ชัน