בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- Open Collective
- כותבים טכניים:
- אנה e só
- שם הפרויקט:
- שיפור מסמכי העזרה הכלליים
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
רושם ראשוני לעיתים קרובות נתקלים בדפי מסמכי עזרה שמכילים הוראות ללא מדיה תומכת (סרטונים, קובצי GIF, תמונות), בעוד שבקטעים אחרים באותו פרק יש רשומות מלאות יותר. לדוגמה, הדף עריכת קולקטיב מורכב מהוראות בלבד, בעוד שהדף הוספת מארח פיסקלי כולל מדיה תומכת.
בדפים שעיינתי בהם, לא הופיע תיאור של אף מדיה באמצעות מאפיין הטקסט החלופי. היעדר תיאורי תמונות מקשה על הבנה מלאה של התיעוד למשתמשים בקוראי מסך ולאנשים עם חיבורי אינטרנט איטיים, שבהם יכול להיות שמדיה לא תיטען.
בחלק מהקטעים במסמכים משולבות שאלות נפוצות והוראות ישירות לניווט בממשק המשתמש, כמו שינוי המארח הפיסקלי. מכיוון שאין טבלת תוכן בממשק של המסמכים, משתמש שמודע לתוצאות של שינוי ברשומות הרישום ופשוט רוצה לקבל הוראות אובייקטיביות עשוי לחשוב שהמסמכים ארוכים מדי ומכילים מידע לא רלוונטי.
אמנם השפה של המסמכים הטכניים עקבית למדי, אבל מדריך הסגנון שזמין לכולם מכיל מעט מדי מידע על אופן כתיבת המסמכים. בדף הוספת תוכן מוזכר שיתוף פעולה ביצירת מסמכי עזרה טכניים, ולכן גם Open Collective וגם שותפים פוטנציאליים יכולים להפיק תועלת מהנחיות מפורטות יותר.
הצעה אני מציע סקירה של דפי העזרה של המשתמשים, ולחשוב מחדש על המצגת שלהם ועל המבנה הנוכחי.
מתודולוגיה וציר זמן אני רוצה לשפר את המסמכים של Open Collective על ידי עבודה עם הקהילה לקידום מחזורי משוב רציפים באורך משתנה.
תקופת ההיכרות עם הקהילה (1 באוגוסט עד 1 בספטמבר 2019): הכרת הקהילה של Open Collective! ראיונות עם חברים פעילים בפרויקטים בולטים ופרויקטים מתחילים, שבהם הם יענו על שאלות לגבי המצב הנוכחי של המסמכים (דוח מס' 1). תיעוד של כל המערכות הפנימיות שמשמשות למעקב אחרי שאילתות ובעיות, ושל התהליך לתיעוד שלהן במסמכי Open Collective (דוח מס' 2). הערכה של בעיות חבויות בגרסה הנוכחית של המסמכים ותכנון פתרון לבעיות האלה (דוח מס' 3).
2-6 בספטמבר: מחזור ראשון של משוב והתאמות, תוך התחשבות בכל התגובות וההצעות שהקהילה שלחה במהלך תקופת היצירת הקשרים בקהילה. התוכנית שלנו מוכנה? יש משהו שצריך לשנות בו? (דוח מס' 4)
9-20 בספטמבר: פיתוח של הוכחת היתכנות עם הפרק פחות מאוכלס במסמך העזר. טיוטה של מדריך סגנון ציבורי (דוח מס' 5).
23-25 בספטמבר: שליחת הוכחת ההיתכנות לבדיקה (קבוצה סגורה).
26-27 בספטמבר: האם צריך לבצע שינויים בהוכחת הקונספט לפני ההשקה? דרושה לנו עוד זמן? צריך לשנות את ההגדרות בהתאם. (דוח מס' 6)
30 בספטמבר עד 9 באוקטובר: הוכחת היתכנות עולה לאוויר. מחזור שני של משוב (קבוצה ציבורית).
10-15 באוקטובר: הערכה סופית של הוכחת היתכנות ומחזור שינויים. (דוח מס' 7)
16-20 באוקטובר: הפסקה קצרה מהפעילויות [1].
21 באוקטובר עד 23 בנובמבר: 'מדריך הסגנון הציבורי' הוא סופי (דוח מס' 8). יישום כל ההוראות שמפורטות במדריך הסגנון בכל דפי המסמכים למשתמש (דוח מס' 9). דיווח על הערכת כל הפעילויות שבוצעו והמלצות נוספות לקהילה (דוח מס' 10).
ניתן להאריך את משך הפרויקט לפי בקשה.
[1]: הנסיעה תוכננה לפני שליחת הבקשה שלי לתוכנית 'עונת Docs'.
תוצרים: - עשרה דוחות ציבוריים על הפעילויות שבוצעו - מדריך סגנון ציבורי שגם שותפי Open Collective וגם שותפים חיצוניים יכולים להשתמש בו - דפי מסמכי עזרה משופרים למשתמש