דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- ScummVM
- כתב טכני:
- קאדי
- שם הפרויקט:
- הפעלת פורטל מסמכים
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
מטרות:
- כדי ליצור תיעוד באיכות גבוהה למשתמשי קצה, באמצעות איחוד כמויות גדולות של מידע ממקורות שונים ושכתוב המידע מחדש כדי לשמור על בהירות, עקביות ושלמות.
- התיעוד צריך להיות מובן למתחילים, ומבלי לשמש בחסות למשתמשים בעלי ידע טכני.
- כדי ליצור פורטל תיעוד באמצעות מחולל אתרים סטטיים.
- למסמכי תיעוד של משתמשי קצה שיהיו זמינים בעתיד על ידי יצירת תבניות והוראות הדרכה מפורטות שיתרמו לעתיד של תוכן בקוד פתוח.
המצב הנוכחי:
- התיעוד הזמין של ScummVM מחולק בין כמה מקורות.
- קשה למצוא את המידע ולעיתים קרובות הוא משוכפל; קל ללכת לאיבוד בדפים מטושטשים.
- קשה לדעת איזה מידע עדכני ואיזה מידע לא עדכני.
- חלק מהמידע חסר או חלקי.
כדי לפתור את הבעיה:
מבנה המסמכים המוצע:
דף הנחיתה
|-- תחילת העבודה
| -- Quick start guide
|-- Installing ScummVM
| |-- Nintendo 3DS
| |-- AmigaOS
| |-- Android
| |-- (every)
| |-- (common)
| |-- (supported)
|-- (פלטפורמה)
|-- שימוש ב-ScummVM
| |-- מרכז האפליקציות
| |-- הגדרות גלובליות
| |-- הגדרות משחק
| -- Keyboard shortcuts
|-- Advanced options
| |-- Cloud and LAN
| |-- Control Mapping
| |-- Configuration
| |-- Command line options
| |-- Graphics
|-- מוזיקה וצלילים
|-- עזרה
| |-- שאלות נפוצות
| |-- אנשי קשר
| |-- בעיות ידועות
| -- Reporting a bug
|-- Game Notes-- נתוני גרסה
- תחילת העבודה:
משתמשים חדשים בדרך כלל מחפשים מדריך להתחלה מהירה כדי להתחיל לעבוד במהירות האפשרית. ההתקנה של ScummVM יכולה להיות מורכבת בפלטפורמות מסוימות, אבל ההתקנה שלו במחשב לא יכולה להיות מורכבת.
המדריך למתחילים אמור לכלול את הנושאים הבאים:
- איך מתקינים את ScummVM ב-Windows, ב-Mac וב-Linux.
כיצד לטעון, להוסיף ולהפעיל משחק.
התקנת ScummVM:
במקרים שבהם ההתקנה אינה אינטואיטיבית, או שבהם למשתמש אין בסיס טכני מבוסס, המשתמש זקוק למדריך מקיף להתקנת ScummVM בכל אחת מהפלטפורמות הנתמכות.
כל דף התקנה מקיף צריך לכלול את הפריטים הבאים:
- כל דרישות המערכת או הדרישות המוקדמות.
- איך מורידים את הגרסה המתאימה של ScummVM.
- איך להתקין את ScummVM.
- איך לטעון משחקים לפלטפורמה שנבחרה, במיוחד אם זו לא הפלטפורמה שבשבילה המשחק מיועד.
איך להפעיל את ScummVM, להוסיף משחק ולהפעיל משחק.
שימוש ב-ScummVM:
המשתמשים צריכים מסמכי עזר שמסבירים איך להשתמש ב-ScummVM.
מסמכי העזר צריכים לכלול את הפרטים הבאים:
- ממשק מרכז האפליקציות; המראה של כל חלון וכרטיסייה, והאופן שבו הם פועלים.
- הסבר על ההגדרות הזמינות, גם גלובליות וגם ספציפיות למשחק.
מקשי קיצור/מקשי קיצור.
אפשרויות מתקדמות:
משתמשים מתקדמים זקוקים למידע טכני נוסף על האפשרויות הזמינות להם לשינוי האופן שבו המשחקים שלהם פועלים.
- הערות המשחק:
מידע ספציפי למשחק שמשתמש צריך לדעת, כולל, בין היתר: - פרטים מיוחדים לגבי ההתקנה - קבצים נוספים נדרשים - פקדים חריגים או שונים
- בעיות מוכרות:
הקטע הזה אמור לכלול את כל הבאגים המוכרים הספציפיים לגרסה.
- נתוני גרסה:
למרות שהמסמכים שלנו יהיו זמינים, תוכלו להיעזר בקטע 'הערות לגבי המוצר' כדי לספק סיכום של השינויים בגרסה האחרונה. יכול להיות שתחומים מסוימים לא נכללים כרגע בתיעוד הזה, כמו משחקים נתמכים חדשים או מידע על מנועים חדשים.
תוכנית התקפה:
אני מציע להתחיל ליצור תבנית לדפים 'התקנת ScummVM', כי זו הדרך הקלה ביותר לקבל את המידע שדרוש לי ממנהלי יציאות או ממפתחים (במיוחד במקומות שבהם המידע הזה דל או לא קיים). אני אמלא מראש כל מידע שכבר יש לי מהמסמכים הקיימים, ואז ניתן יהיה לבדוק את שלמותו, הדיוק ואת המטבע שלו, או להוסיף אותו לפי הצורך.
בשלב הבא אסרוק את התיעוד הקיים: README, wiki והאתר. בהמשך, אכתוב מחדש ואוסיף כל קטע לפי הצורך ואעביר את כל המידע לפורטל החדש. אני גם אציין איזה מידע נלקח מאיפה, כדי לוודא שברגע שהפורטל פעיל, אין כפילויות, סתירות או חריגות אחרות.
במהלך העבודה אקשר בין המנטורים, המפתחים, מנהלי הנמלים ומומחים אחרים בעלי ידע בתחום כדי למצוא מידע חסר, וכדי להבטיח שכל דף יהיה עדכני ומקיף ככל האפשר.
ברוח שיתוף הפעולה, ובכפוף לאישור של המנטורים, אני רוצה שפורטל העבודה תוך כדי עבודה יהיה נגיש לקהילת ScummVM לכל אורך תהליך הכתיבה, כדי לקבל משוב בזמן אמת ולהבטיח שלא תפספסו שום דבר במהלך העבודה.
אני מציע להשתמש במדריך סגנון, כמו מדריך הסגנון לתיעוד למפתחים של Google, כדי לשמור על עקביות לגוף העבודה הזה ולתיעוד שלו בעתיד.
כשאפשר, אשתמש בצילומי מסך, בקובצי GIF ובעזרים ויזואליים אחרים כדי לשפר את ההבנה.
ציר הזמן המוצע:
איחוד הקהילה 17 באוגוסט עד 13 בספטמבר 2020
המשיכו להקדיש זמן לשיחה עם המנטורים ועם קהילת ScummVM הרחבה יותר כדי לכוונן את החזון לפרויקט ולהשלים פרטים כמו מבנה המסמך והתוכן.
שבוע 1 14 בספטמבר – 20 בספטמבר
- יוצרים תבנית לדפי ההתקנה הספציפיים לפלטפורמה מסוימת.
- ממלאים מראש את התבניות בפרטים קיימים ומעבירים אותם למנהלים או למפתחים המתאימים של הניודים לקבלת מידע נוסף.
שבוע 2 21 בספטמבר – 27 בספטמבר
- מגדירים את פורטל התיעוד החדש.
שבוע 3 28 בספטמבר – 4 באוקטובר
באמצעות ScummVM: - הממשק - הגדרות גלובליות התקנת ScummVM: - מוחזרים מדריכי התקנה ספציפיים לפלטפורמה, כמו גם עם תבניות שהושלמו.
שבוע 4 5 באוקטובר עד 11 באוקטובר
שימוש ב-ScummVM: - הגדרות המשחק - מקשי קיצור התקנת ScummVM: - מוחזרים מדריכי התקנה ספציפיים לפלטפורמה, כמו גם עם תבניות שהושלמו,
שבוע 5 12 באוקטובר עד 18 באוקטובר
אפשרויות מתקדמות: - ענן ו-LAN - מיפוי בקרה התקנת ScummVM: - מוחזרים מדריכי התקנה ספציפיים לפלטפורמה, לאחר השלמת התבניות שהושלמו
שבוע 6 19 באוקטובר עד 25 באוקטובר
אפשרויות מתקדמות: - הגדרה - אפשרויות של שורת הפקודה התקנת ScummVM: - המערכת מחזירה מדריכי התקנה ספציפיים לפלטפורמה, לאחר השלמת התבניות שהושלמו
שבוע 7 26 באוקטובר עד 1 בנובמבר
אפשרויות מתקדמות: - גרפיקה - אודיו התקנת ScummVM: - מדריכי התקנה ספציפיים לפלטפורמה, כמו גם תבניות שהושלמו, מוחזרים אליי
שבוע 8 2 בנובמבר עד 8 בנובמבר
עזרה: - שאלות נפוצות - אנשי קשר - בעיות ידועות
התקנת ScummVM: - מדריכי התקנה ספציפיים לפלטפורמה כאשר תבניות שהושלמו מוחזרים לי
שבוע 9 9 בנובמבר עד 15 בנובמבר
עזרה: - דיווח על באג - הערות לגבי המשחק - נתוני גרסה
התקנת ScummVM: - משלימים את כל מדריכי הפלטפורמות שעדיין לא הושלמו.
שבוע 10 16 בנובמבר עד 22 בנובמבר
- עריכה, הגהה וסיום של החלטות שקשורות לפורטל, כמו ניווט בסרגל הצד, שינויים בעיצוב או ב-CSS וכו'.
- מוודאים שכל הקישורים פועלים כמצופה.
- לבדוק שהתמונות או קובצי ה-GIF מוצגים כמו שצריך.
שבוע 11 23 בנובמבר עד 30 בנובמבר
- השלימו את כל הפריטים העודפים והשיקו את הפורטל באופן רשמי!
- לאחר השקת הפורטל, הקפידו להסיר מידע מיותר ממקורות אחרים בהתייעצות עם המנטורים.