דף זה מכיל את הפרטים של פרויקט כתיבה טכני שהתקבל בעונת Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- העיקרי
- כתב טכני:
- @anindita_basu
- שם הפרויקט:
- בדיקה וצמצום של הטקסט במוצר
- אורך הפרויקט:
- משך זמן ארוך (5 חודשים)
תיאור הפרויקט
הצטרפתי לערוץ של Slack ושלחתי כמה שאלות לאריק.
בהתאם לתשובה שלו (תודה, אריק!), אני מציע לגשת לפרויקט הזה
באופן הבא:
סיווג המחרוזות
אתחיל לזהות אילו מהמחרוזות (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) הן מחרוזות של קונסולה, ואילו מחרוזות מוצגות למשתמשים. אני מציע לבחון קודם את המחרוזות שמוצגות למשתמשים.
יצירת מדריך סגנון למחרוזות
אני רוצה להגדיר את הסגנון של שימוש באותיות רישיות, באורך ובמילים של מחרוזות שמוצגות בפריטים בתפריט, בלחצני פעולה, בתוויות, בכותרות, בהסברים קצרים, בשגיאות, באזהרות, באימות, בהתראות ובאישורים (אפשר לעיין בצילום מסך לדוגמה של מדריך סגנונות בכתובת https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). בנוסף, אני רוצה ליצור הדרכה לגבי השימוש באסימונים (placeholders) במחרוזות, במיוחד במחרוזות מורכבות.
המטרה שלי היא להציג את ההנחיות האלה בדף אחד בגודל A4, קצר ככל האפשר. מתוך כוונה, מפתחים שכותבים את המחרוזות האלה צריכים למצוא את ההנחיות במהירות ובקלות. בנוסף, אם משתמשים בהן, הטקסט בממשק המשתמש יפגין עקביות בכל המסכים.
אני מציע לעשות זאת משתי סיבות: (א) כדי לשמור על עקביות בטקסט מבחינת הדקדוק והסגנון (ב) כך שגם אחרי ש-GSoD יסתיים, תהיה סדרה של הוראות שכל אחד יוכל לעיין בהן במהירות במהלך כתיבת טקסט בממשק המשתמש
בודקים ומשפרים את הטקסט
בהתאם למדריך הסגנון שנוצר ב-2, אני אערוך את המחרוזות ואצור בקשות משיכה ב-GitHub.
=============
משך הקורס
עדיין לא ידוע לי כמה מהמחרוזות הן מחרוזות שמוצגות למשתמשים (זה מה שאני מציע לבדיקה בפרויקט הזה). אני מעריך שיצירת מדריך הסגנון יארך כ-3 שבועות (מהטיוטה ועד לאישור), וניתן לבצע את העבודה בו-זמנית על ידי סיווג מחרוזות כמחרוזות מערכת או כהצגה למשתמש. אני מציע להתחיל בהנחה שהפרויקט יהיה פרויקט באורך סטנדרטי (3 חודשים), שבו אוכל להשתמש במספר מוגבל של מחרוזות לבדיקה במסגרת הזמן הזו.
אני כבר מועסק במשרה מלאה, כך שאוכל לעבוד רק על חלק מהיום. אם נראה לך שיש צורך בשעות העבודה המופחתות שלי, אשמח לקבל פרויקט ארוך יותר.