בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- פרויקט FreeBSD
- כותבים טכניים:
- quaffeine
- שם הפרויקט:
- יצירת פרק במדריך Wine
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
במסגרת היוזמה הזו אפיק פרק מעמיק ומדריך באורך ספר של מדריך FreeBSD בנושא ההתקנה, השימוש ופתרון הבעיות של WINE (www.winehq.org) ב-FreeBSD. אנסה להקדיש 4-8 שעות בכל שבוע לעבודה על הפריטים הבאים, אלא אם יצוין אחרת.
*** קישור בין חברי הקהילה
אם אבחר, אמשיך את תקופת החיבור לקהילה כדי להכיר את תהליכי התיעוד והתשתית של פרויקט FreeBSD. תמיד התרשמתי מהתיעוד המלוכד שהפרויקט הוציא, והייתי עובדת בשיתוף עם חברי הצוות של הפרויקט בנוגע לתהליך העבודה שלהם. מומלץ גם להצטרף לפורומים שמתמקדים במשתמשים ולעיין בהם כדי לקבל מושג לגבי הדברים שיעזרו למשתמשים ב-FreeBSD לגבי מסמכי העזרה באופן כללי, ולעבודה עם WINE ב-FreeBSD בפרט.
במהלך התקופה הזו, כדאי להקדיש זמן ללמידת כלי התיעוד של הפרויקט. כך אוכל להתחיל לעבוד בשבועות הראשונים של הפרויקט, אם איבחר.
*** שבוע 1 (14-19 בספטמבר): בדיקת התקנות ופתרון בעיות
בשבוע הראשון של שלב פיתוח המסמכים, אנסה להתקין את WINE בגרסה היציבה הנוכחית של FreeBSD, ואתקין ואפעיל מגוון אפליקציות של Windows, החל משירותים פשוטים ועד לאפליקציות מורכבות יותר. זו הגישה שבחרתי במאמר דומה שכתבתי על ReactOS עבור MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/), רק שבשבועיים הראשונים אבדוק מבחר רחב יותר של תוכנות.
מניסיוני, ניהול זמן מראש מהסוג הזה עוזר לזהות (ולפתור בעיות) סוגי בעיות כלליים מסוג "gotcha". כך אוכל לקבל את הפתרונות כשהזמן יגיע לכתוב את הקטעים הרלוונטיים, או לפחות לשלוח בקשות לקבלת עזרה לערוצים המתאימים.
היעד של השבוע: לקבל תיאור של פרקי ההתקנה ופרטים נדרשים לגבי פתרון בעיות נפוצות בהתקנה.
*** שבוע 2 (21-29/9): תיעוד התקנת WINE
בשבוע השני אנסח את הקטעים שממחישים את התקנת WINE באמצעות שיטות פופולריות, כולל:
- מהמקור באמצעות מערכת השקעים.
- באמצעות חבילות בינאריות באמצעות מאגרי ליבה;
- שימוש במנהל חבילות GUI זמין אם הוא זמין, וכן;
- ממאגרים חלופיים כמו FreshPorts (ולמה משתמש ירצה לעשות זאת).
חשוב להתייחס בקטע הזה להבדל בין התקנות 32 ביט לבין התקנות 64 ביט, ולהדגיש את השלבים הנוספים הנדרשים להרצת תוכנות בארכיטקטורות שונות.
יעד השבוע: גרסה מבריקה של טיוטת הקטעים שמתארים את התקנת WINE ב-FreeBSD. ב ""טיוטה המשופרת"" צריך לכלול טקסט כמעט סופי (בהמתנה לתיקון שגיאות ולתגובות מהבדיקה) ו-placeholders של צילומי מסך, אם לא את צילומי המסך עצמם.
*** שבוע 3 (28 בספטמבר עד 2 באוקטובר): הפעלת תוכנית WINE הראשונה ב-FreeBSD
אחרי שתתקינו את מערכת המשנה של WINE, בקטע הבא נסביר איך להתקין ולהריץ כמה תוכנות ראשוניות. סביר להניח שהן יתמקדו בכלים פשוטים ועצמאיים, כמו Notepad++ בקוד פתוח. המטרה היא לאפשר למשתמשים להוריד אפליקציה במהירות, להתקין אותה ולראות שהיא פועלת ללא טרחה רבה.
הקטע הזה חשוב כדי להראות למשתמשים שחלק/הרבה מאפליקציות Windows יכולות לפעול ב-FreeBSD, ולכן זוהי אפשרות קיימת לשימוש יומיומי.
יעד השבוע: זיהוי מספר קטן של תוכנות שמתקינות בצורה נקייה ועובדות (בדרך כלל) 'מהקופסה', וכן גרסה מבריקה של טיוטת הקטעים שממחישים את ההתקנה שלהן.
*** שבוע 4 (5-9 באוקטובר): סקירה כללית ומושגים של WINE
סוף הקטע הקודם ירמז על הצורך לבצע כוונון והתאמה אישית כדי לגרום לאפליקציות מסוימות לעבוד ב-WINE, שבשלב זה מבוא למערכת המשנה WINE יהיה שימושי כדי לספק הקשר. בקטעים האלה נבדוק מה מגיע עם מערכת WINE, איך היא מתקשרת עם FreeBSD ואיפה המשתמש יכול להתחיל לחפש מידע נוסף על המערכת או לפתור בעיות.
חשוב לציין שהקטע הזה לא נועד לחזור על מידע שכבר קיים במקורות אחרים, אלא להציג סקירה כללית מאורגנת עם קישורים למקורות מידע אחרים (שקל לעכל את המידע שבהם) לקבלת מידע נוסף.
יעד השבוע: טיוטה מבריקה של הקטעים שמציגים למשתמשים את מערכת המשנה של WINE.
*** שבוע 5 (12-16 באוקטובר): הגדרת WINE ב-FreeBSD
הקטעים האלה יתעמקו בתצורה האמיתית של WINE, החל משינויים/כוונון כלליים ספציפיים ל-FreeBSD. הם גם ממחישים את השימוש בתיקיות $WINEPREFIX, שניתן להשתמש בהן כדי להתאים אישית את סביבת WINE עבור אפליקציה מסוימת. יש משאבים קיימים שמסבירים את המושג הזה בהרחבה, ולכן הסעיף הזה כולל רק מבוא מפורט במידה בינונית לפני הקישור אליהם.
היעדים של השבוע: טיוטה מנוסחת היטב של הקטעים, שמפרטת איפה, איך ובאילו נסיבות נדרשת הגדרה מפורטת של WINE.
*** שבוע 6 (19-23 באוקטובר): ממשקי משתמש גרפיים של WINE ב-FreeBSD
הגדרת WINE להרצת תוכנית מסוימת יכולה להיות משימה מורכבת שדורשת זמן רב, אבל יש כלים שיעזרו לכם להקל על התהליך. בקטעים האלה תמצאו סקירה כללית על ההתקנה והשימוש בחלק מהאפשרויות שקיימות ב-FreeBSD, כולל:
- WINECfg
- יקבים
- playonbsd
- אחרים לפי הזמינות
יעד השבוע: לספק קטעים מוכנים של טיוטות עם הוראות להתקנה ולשימוש בכמה שיותר מהאפליקציות הנפוצות ביותר של WINE עם ממשק משתמש גרפי, ככל האפשר.
*** שבוע 7 (26-30 באוקטובר): שאלות נפוצות על WINE/FreeBSD (מחקר)
חלק מהמידע החשוב ביותר לגבי אפליקציות טכניות מורכבות כמו WINE מופיע באינטראקציה בין משתמשים שמנסים לפתור בעיות מסוימות לבין מומחים שמספקים תשובות. אם חלק מהשאלות הנפוצות האלה, במיוחד אלה שידועות כמשפיעות על משתמשי FreeBSD, ייאספו במקום אחד, המשתמשים יוכלו לחסוך הרבה זמן.
המטרה של הקטעים האלה היא לעשות בדיוק את זה, ואני אעביר את השבוע הזה רק במחקר של סוגי הבעיות הנפוצות של משתמשי FreeBSD ב-WINE, וגם בחיפוש תשובות ובבדיקתן (עד כמה שאפשר). כך קוראי הפרק במדריך הזה יקבלו הזדמנות טובה יותר לפתור במהירות בעיה מסוימת.
בקטעים האלה תופיע גם רשימת מקורות מידע שבהם אפשר לחפש תשובות שלא סיפקו.
יעד השבוע: קטעים מנוסחים היטב שמכילים את הבעיות הנפוצות ביותר ב-WINE, כפי שהן נתקלו בהן על ידי משתמשי FreeBSD או באופן כללי, וקישורים או הערות לגבי הפתרונות שלהן. לתשומת ליבך, לא נוצרו טיוטות של תוצרים במהלך העבודה השבועית, אבל סביר להניח שיידרש השקעה זמן גדולה יותר כדי למצוא בעיות נפוצות ולטפל בהן, וגם כדי למצוא פתרונות לבעיות האלה. אני צפוי להקדיש למחקר הזה כ-8 עד 10 שעות.
*** שבוע 8 (2-6 בנובמבר): שאלות נפוצות בנושא WINE/FreeBSD
השבוע נשתמש בממצאי המחקר של שבוע 7 כדי ליצור את הקטעים של השאלות הנפוצות או הבעיות הנפוצות בפתרון בעיות (עם קישורים לפתרונות, לפי הצורך).
היעד של השבוע: טיוטה מנוסחת היטב של הקטעים, שבה מפורטים השאלות הנפוצות או הבעיות שאתם נתקלים בהן לעיתים קרובות, והוראות מפורטות לפתרון הבעיות.
*** שבוע 9 (9-13 בנובמבר): ניהול WINE בכמה משתמשים
בקטעים האלה תמצאו הדרכה לאדמינים שמעוניינים לפרוס את WINE בתרחיש של משתמשים מרובים. היא תכלול לא רק שיטות מומלצות לשיתוף מערכת המשנה עצמה בין כמה משתמשים, אלא גם לגבי אפליקציות Windows שנפרסות ב-WINE.
יעד השבוע: קטעים מוכנים לשימוש עם הנחיות ושיטות מומלצות לאדמינים של FreeBSD לפריסה של WINE ואפליקציות מבוססות-WINE לכמה משתמשים.
*** שבוע 10 (16-20 בנובמבר): נספח, בדיקת משוב וענייני ניהול
אשתדל ליישם את כל המשוב שאקבל ממנטורים ומבודקים אחרים במהלך תהליך הכתיבה, אבל השבוע יאפשר לי לבצע ארגון מחדש או כתיבה מחדש מקיפה יותר, אם יהיה צורך.
בנוסף, במהלך פרק הזמן הזה אכתוב את כל המידע הנדרש לניהול הפרק הזה במדריך (תוכן מקדים, אינדקסים וכו'), ואצור רשימה של מקורות מידע נוספים בנושא WINE (למשל, שימוש בגרסה של WINE ל-Linux באמצעות תאימות בינארית, DOSBox למשחקים או לתוכניות ישנות וכו').
היעד של השבוע: טיוטה מנוסחת היטב של כל הפרק במדריך, כולל כל שאר הסעיפים.
*** שבוע 11 (23-27 בנובמבר): סיום העבודה על פרק במדריך
את השבוע השני עד האחרון אקדיש להגהה של כל הטקסט, לבדיקת תמונות ולבדיקת הפלטים השונים (HTML, PDF וכו') לפי הצורך. השבוע הזה יאפשר גם עדכונים במקרה שתוכנה כלשהי מהתוכנות שלמעלה (מ-FreeBSD עצמה ועד WINE או התוכנות שיעזרו לכם להשתמש בה) תתעדכן מאז הכתיבה הראשונית שלה.
יעד השבוע: גרסה סופית של פרק במדריך, כולל כל העדכונים הנדרשים.
*** שבוע 12 (30-12/11): סיום הפרויקט
בהסכמה עם מנחי הפרויקט, אשמור את הפרק בספר הדרכה במערכת בקרת הגרסאות, ארכיב את דוח הפרויקט ואשלח את הפרויקט כשהוא מוכן.