בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית 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 ולנסות אותו בעצמי ולתעד בעיות שנתקלת בהן. יש לי שלושה מחשבים: Lenovo Thinkpad, Dell Latitude ו-Acer Aspire. אנסה את Qubes בכל אחד מהמחשבים האלה, אתעדה שגיאות ואבדוק את הפתרונות לבעיות.
- מסירים מידע מיושן מהמדריך הקיים.
- מוודאים שהפתרונות לבעיות מדויקים. נכון לעכשיו, במדריכים הקיימים לפתרון בעיות מופיעה הודעת השגיאה "This is unofficial, third-party documentation" (זהו מסמך לא רשמי של צד שלישי). צוות הפרויקט של Qubes OS לא יכול להבטיח את הדיוק של הדף הזה. יש להפעיל שיקול דעת"". האזהרה הזו תבוטל אחרי שנאמת שההוראות לפתרון הבעיות מדויקות. כדי לוודא שהן מדויקות, אבדוק באופן אישי את הפתרונות לבעיות במחשבים שלי (אם אפשר) או אבדוק באינטרנט אם משתמשים אימתו את הפתרון.
- מעבירים את כל פתרון הבעיות החיצוני (מהפורום ומ-GitHub) לדף האינטרנט הרשמי של פתרון הבעיות.
- אתם יכולים לחקור ולמצוא בעיות נוספות שבהן נתקלו משתמשים ב-Reddit (r/QubesOS), ב-Stack Exchange, בקבוצת Google #qubes-users ובבעיות ב-GitHub. אשתמש גם בכלים למחקר מילות מפתח כמו Keywordtool.io ו-UberSuggest.com כדי לגלות אילו שאלות נפוצות מחפשים במנועי חיפוש כמו Google.
- מוסיפים את הקטע 'קבלת עזרה', אם המדריך לפתרון בעיות לא פותר את הבעיה של המשתמשים. אפשר לראות דוגמה בדף פתרון הבעיות של Fedora: https://docs.FedExoraproject.org/en-US/fedora/raw הרשומים/install-guide/install/troubleshooting/#sect-troubleshooting-getting-help.
למה כדאי לפרויקט הזה?
אני מתעניינת מאוד בטכנולוגיה, במיוחד באבטחת סייבר ובפרטיות. אני מאמינה שכתיבה היא אחד היכולות הכי חזקות שלי. מערכת ההפעלה Qubes מעניינת אותי במיוחד כי היא משלבת בין שני תחומי עניין עיקריים שלי: אבטחה ופרטיות. אני משתמש/ת נלהב/ת במוצרים אחרים שמתמקדים באבטחה ובפרטיות כמו DuckDuckGo ו-Tor. גיליתי את Qubes OS רק לאחרונה, וממש אהבתי אותו.
למה לדעתי אני האדם המתאים לפרויקט הזה
- העיקרון שלי הוא אבטחה, פרטיות וכתיבת מסמכים מועילים או טובים.
- נתקלתי בבעיות בהתקנה ובשימוש ב-Qubes OS, כך שאוכל לתאר את הבעיות האלה בצורה טובה יותר בהוראות לפתרון בעיות.
- בחודש האחרון למדתי את ההיבטים הטכניים של מערכת ההפעלה Qubes. למדתי גם את התיעוד של Qubes OS לעומק. כדי להבין את תהליך עריכת המסמכים, יצרתי בקשת משיכה (https://github.com/QubesOS/qubes-doc/pull/1005/files)
- סיימתי לאחרונה סטאז' בפרויקט Tor. התפקידים שלי היו תמיכה טכנית וכתיבה. במהלך העבודה במרכז העזרה, קיבלתי מאות שאלות ממשתמשים שהתמודדו עם בעיות במהלך ההתקנה או השימוש בדפדפן Tor. בעזרת המשתמשים האלה למדתי איך לכתוב הוראות קצרות וברורות לפתרון בעיות
- כשעבדתי בפרויקט Tor, כתבתי גם תיעוד טכני באמצעות Markdown. השתמשתי ב-Git, ב-GitHub וב-GitLab לצורך בקרת גרסאות.