หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- ระบบปฏิบัติการ Qubes
- ผู้เขียนด้านเทคนิค:
- C1e0
- ชื่อโปรเจ็กต์:
- รวมคู่มือการแก้ปัญหา
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
ขีดฆ่า
คู่มือการแก้ปัญหาออกแบบมาเพื่อช่วยผู้ใช้ปลายทางแก้ไขปัญหาที่พบเมื่อใช้ผลิตภัณฑ์หรือบริการ คู่มือการแก้ปัญหาที่ดีนั้นมีความสำคัญ เนื่องจากจะช่วยเหลือผู้ใช้เมื่อเกิดปัญหา ช่วยป้องกันไม่ให้ผู้ใช้ละทิ้งผลิตภัณฑ์เมื่อพบปัญหา Qubes มีผู้ใช้งานรายวันหลายพันรายทั่วโลก ซึ่งหลายๆ คนอาจพบปัญหาในบางช่วงเวลาและจะได้รับประโยชน์จากคู่มือการแก้ปัญหา
สถานะปัจจุบันของคู่มือการแก้ปัญหา
ขณะนี้คู่มือการแก้ปัญหาของ QubesOS นั้นกระจัดกระจายอยู่หลายหน้าและบางครั้งก็ไม่สมบูรณ์ ทำให้มีการโพสต์คำสั่งเดียวกันซ้ำแล้วซ้ำอีกเมื่อช่วยผู้ใช้วิเคราะห์ปัญหา คู่มือที่มีให้ไม่มีเลย์เอาต์แสดงลักษณะปัญหา ซึ่งทำให้ผู้ใช้จับคู่ปัญหากับวิธีแก้ปัญหาได้ยาก นอกจากนี้ มีการกล่าวถึงปัญหาบางอย่างซ้ำๆ ในโซเชียลมีเดีย (Reddit), หน้าปัญหาเกี่ยวกับ Qubes GitHub และในฟอรัม #qubes-users แต่ไม่ได้มีการบันทึกไว้ในคู่มือการแก้ปัญหาฉบับปัจจุบัน
เหตุใดคำแนะนำการแก้ปัญหาที่ฉันเสนอจึงถือเป็นการปรับปรุงที่มีอยู่แล้ว
คู่มือการแก้ปัญหาที่ฉันนำเสนอจะเป็นคู่มือฉบับสมบูรณ์และมีโครงสร้างที่ถูกต้องเพื่อให้ไปยังส่วนต่างๆ ได้ง่าย คู่มือนี้จะแสดงคำแนะนำที่กระชับซึ่งอธิบายวิธีแก้ปัญหาทีละขั้นตอน โดยจะแสดงเลย์เอาต์การตรวจพบปัญหา โดยจะระบุปัญหาตามแนวทางที่แนะนำเพื่อแก้ไขปัญหานั้น การแก้ปัญหาจะได้รับการเพิ่มประสิทธิภาพเครื่องมือค้นหา และใช้ถ้อยคำเพื่อพิจารณาถึงปัญหาที่ผู้ใช้ค้นหาในโซเชียลมีเดียและเครื่องมือค้นหา ทั้งหมดนี้จะช่วยให้มั่นใจว่าผู้ใช้จะพบคู่มือการแก้ปัญหาอย่างเป็นทางการผ่านเครื่องมือค้นหาและค้นพบวิธีแก้ปัญหาของตนได้อย่างรวดเร็ว/ง่ายดาย
โครงสร้างของคู่มือการแก้ปัญหาที่เสนอและกรอบเวลา
ฉันได้สร้างโครงสร้างที่เสนอสำหรับคู่มือการแก้ปัญหาของระบบปฏิบัติการ Qubes ซึ่งดูได้ที่ 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 และ GitHub นอกจากนี้ฉันจะใช้เครื่องมือวิจัยคีย์เวิร์ด เช่น Keywordtool.io และ UberSuggest.com เพื่อดูคำถามที่มักมีคนค้นหาบนเครื่องมือค้นหาอย่าง Google
- เพิ่มส่วน "การรับความช่วยเหลือ" ในกรณีที่คู่มือการแก้ปัญหาไม่สามารถแก้ปัญหาของผู้ใช้ได้ ดูตัวอย่างได้ในหน้าการแก้ปัญหาของ Fedora: https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/troubleshooting/#sect-troubleshooting-เรียก-help
ทำไมต้องเป็นโครงการนี้
ฉันหลงใหลเกี่ยวกับเทคโนโลยี โดยเฉพาะการรักษาความมั่นคงปลอดภัยไซเบอร์และความเป็นส่วนตัว ฉันเชื่อว่าการเขียนเป็นตัวเลือกหนึ่งที่แข็งแกร่งที่สุด ฉันสนใจระบบปฏิบัติการ Qubes เป็นพิเศษเพราะระบบปฏิบัติการนี้ตรงข้ามกับความสนใจหลัก 2 อย่างของฉัน ได้แก่ ความปลอดภัยและความเป็นส่วนตัว ฉันชื่นชอบการรักษาความปลอดภัยและความเป็นส่วนตัวอื่นๆ เป็นประจำ เช่น DuckDuckGo และ Tor ฉันเพิ่งค้นพบระบบปฏิบัติการ Qubes และตอนนี้ฉันชอบมากแล้ว
เหตุใดฉันถึงเชื่อว่าฉันเป็นบุคคลที่ถูกต้องสำหรับโปรเจ็กต์นี้
- ฉันใส่ใจเกี่ยวกับความปลอดภัย ความเป็นส่วนตัว และการเขียนเอกสารที่ดี/เป็นประโยชน์
- เนื่องจากฉันเคยพบปัญหาขณะติดตั้งและใช้ระบบปฏิบัติการ Qubes เราจึงสามารถแสดงปัญหาเหล่านี้ได้ดียิ่งขึ้นในวิธีการแก้ปัญหา
- ในเดือนที่ผ่านมา ฉันได้ศึกษาด้านเทคนิคของระบบปฏิบัติการ Qubes ฉันได้ศึกษาเอกสารประกอบของระบบปฏิบัติการ Qubes อย่างกว้างขวาง เราได้สร้างคำขอพุล (https://github.com/QubesOS/qubes-doc/pull/1005/files) เพื่อให้เห็นภาพกระบวนการแก้ไขเอกสารประกอบแล้ว
- ฉันเพิ่งจบการฝึกงานที่โปรเจ็กต์ Tor บทบาทของฉันคือการสนับสนุนด้านเทคนิคและการเขียน ขณะทำงานที่แผนกช่วยเหลือ ฉันได้รับคำถามหลายร้อยข้อจากผู้ใช้ที่ประสบปัญหาเมื่อติดตั้งหรือใช้เบราว์เซอร์ Tor การช่วยผู้ใช้เหล่านี้แก้ปัญหาทำให้ผมได้เรียนรู้วิธีเขียนวิธีการแก้ปัญหาที่กระชับและเข้าใจง่าย
- ขณะทำงานที่ Tor Project ผมก็เขียนเอกสารประกอบทางเทคนิคโดยใช้ Markdown ด้วยเช่นกัน ฉันใช้ Git, GitHub และ GitLab ในการควบคุมเวอร์ชัน