בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- Qubes OS
- כותב טכני:
- luzeal
- שם הפרויקט:
- Onboard with QubesOS ! בואו נכתוב מדריך פתוח וקל לשימוש
- משך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
הצטרפות ל-QubesOS !
אני רוצה ליצור מדריך פתוח וחומרים קשורים למשתמשי QubesOS בפעם הראשונה. המטרה היא להציג את QubesOS לאנשים שאין להם ידע טכני, ולשמור על המדריך תמציתי ומובן ככל האפשר, באמצעות אנלוגיות, איורים ודיאגרמות. כדי שהתשובה תהיה תמציתית, אשתמש בקישורים למקורות מהימנים, כולל אלה שמופיעים באתר QubesOS. כל התוכן יפורסם ברישיון קוד פתוח.
הכוונה בתוכן עצמאי היא ליחידת תוכן שיכולה להתקיים בנפרד מהאתר, למשל מדריך. היא לא זהה לגרסה הלא מקוונת של המדריך. מומלץ ליצור עוד צינור להעלאת התוכן כמדריך, לצד האתר.
במדריך פתוח אני מתכוון למדריך שיפורסם ברישיון פתוח.
איך אפשר לעשות את זה
הגדרת קהל היעד
נכון לעכשיו, נראה לי שהקטגוריה של המשתמשים שאליהם מכוונת מערכת QubesOS לא מוגדרת היטב. איך QubesOS יכולה לעזור לעיתונאים, לעורכי דין, למומחי אבטחה, למפתחי תוכנה וכו'? אשמח לקבל תיאור של תרחישים שבהם QubeOS יכול להיות שימושי.
הגדרת ציפיות נכונה
חשוב גם להזהיר משתמשים חדשים שנדרש ידע מסוים בתחום ה-IT כדי להשתמש ב-QubesOS. יש מחיר שצריך לשלם כדי להשתמש ב-QubesOS, מבחינת נוחות השימוש, במיוחד אם QubesOS היא מערכת המחשוב העיקרית שלכם. באותו אופן, יש דברים ש-QubeOS לא תעשה טוב (מתוך כוונה), כמו האצת תלת-ממד במכונות וירטואליות. חשוב להבהיר את זה מההתחלה, לא כדי להרתיע אנשים משימוש באפליקציה, אלא כדי להגדיר ציפיות למשתמשים פוטנציאליים.
מה זה QubesOS ומה זה לא
למרות ש-QubesOS היא סוג מיוחד של מערכת הפעלה (הפצת Xen), יהיה מעניין להשוות אותה למערכות הפעלה אחרות על סמך הפונקציונליות שלהן או היעדר הפונקציונליות שלהן (לדוגמה, Windows משתמשת יותר ויותר בווירטואליזציה ובארגז חול כמנגנוני אבטחה). אפשר להשתמש בתרשים או בטבלה פשוטים.
המפרטים של המדריך יוגדרו יחד עם הקהילה.
מהו המידע המינימלי שהמדריך צריך להכיל? עד כמה אפשר לפשט את ההתקנה בלי לפגוע באבטחה? איפה צריך להגדיר את הסף? האם יש דבר כזה, הגדרה מינימלית של QubesOS שגם מאובטחת? אם לא, אפשר להגדיר אותו כיעד של המדריך.
רישיון
קבלת רישיון. בוויקי של Archlinux, שזוכה להערכה רבה, נעשה שימוש ברישיון GNU Free Documentation License 1.3 ואילך. האם הרישיון הזה מתאים?
פעילויות אחרות
שיפור המראה של תיעוד האתר
אפשר להדגיש את ההערות בצבע אדום או צהוב כדי שיהיה קל יותר לשים לב אליהן. לדוגמה, אפשר להשתמש בתיבות צבע, כמו אלה שמופיעות בוויקי של archlinux. https://wiki.archlinux.org/index.php/Linux_Containers.
אפשר להשתמש בציטוטים ארוכים.
קישור התוכן
בשלב הזה יש הרבה תוכן באתר התיעוד, אבל לעיתים קרובות אין קישורים בין חלקי התוכן השונים לנושאים רלוונטיים אחרים. אפשר לקשר בין מאמרים כדי לשפר את יכולת הגילוי.