דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של 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 מסתיים, יש סדרה של הוראות שכל אחד יכול לעיין בהן במהירות כאשר הוא כותב טקסט בממשק המשתמש
בדיקה ושיפור של הטקסט
בהתאם למדריך הסגנון שנוצר בשלב השני, אערוך את המחרוזות ואצור בקשות משיכה ב-GitHub.
=============
משך הזמן
אני עדיין לא יודע כמה מהמחרוזות הן מחרוזות שמוצגות למשתמשים (זו ההצעה שלי לבדיקה בפרויקט הזה). להערכתי, תהליך היצירה של מדריך הסגנון יימשך כ-3 שבועות (מטיוטה ועד לאישור), ואפשר לבצע אותו במקביל על ידי סיווג מחרוזות כמחרוזות מערכת או כמחרוזות שמוצגות למשתמשים. אני מציע להתחיל מתוך הנחה שהפרויקט יהיה פרויקט באורך רגיל (3 חודשים), שבו אוכל לבדוק את מספר המחרוזות הגבוה ביותר שניתן במסגרת הזמן הזו.
העסק שלי כבר מועסק במשרה מלאה, ולכן אוכל לעבוד רק חלק מהיום. אשמח לעבוד על פרויקט ארוך יותר אם נראה לך שיהיה צורך בכך.