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