דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.
סיכום הפרויקט
- ארגון הקוד הפתוח:
- Open Collective
- כתב טכני:
- אנה אה סו
- שם הפרויקט:
- שיפור של תיעוד העזרה הכללי
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
רושם ראשוני פעמים רבות נתקלים בדפי תיעוד שמכילים הוראות ללא מדיה תומכת (סרטונים, קובצי GIF, תמונות) בעוד שקטעים אחרים באותו פרק כוללים ערכים מלאים יותר - למשל, Edit Collective מורכב מהוראות בלבד, בעוד Add Fiscal Host כולל מדיה תומכת.
בדפים שעיינתי בהם לא מתואר אף מדיה באמצעות מאפיין הטקסט החלופי. היעדר תיאורי תמונות פוגע בהבנה המלאה של התיעוד לאנשים שמשתמשים בקוראי מסך ובחיבורים איטיים יותר לאינטרנט, שבהם מדיה עשויה להיכשל.
בחלקים מסוימים של השאלות הנפוצות לגבי מיזוג המסמכים והוראות ישירות לניווט בממשק המשתמש, כמו שינוי מארח כספי. מכיוון שאין תוכן עניינים בממשק התיעוד, משתמש שמודע להשלכות של שינוי ברשומות הרישום ומעוניין בהוראות אובייקטיביות בלבד עלול לראות שהתיעוד מילולי ומשיק לי מדי.
אף על פי שהשפה של התיעוד הטכני עקבית, מדריך הסגנון הזמין לציבור כולל מעט מדי מסמכים לגבי האופן שבו צריך לכתוב את התיעוד. מכיוון שהדף לתרומה כולל אזכור של תכנים למסמכים טכניים, גם Open Collective וגם תורמים פוטנציאליים יכולים להפיק תועלת מהנחיות מקיפות יותר.
הצעה אני מציע בדיקה של דפי העזרה של המשתמשים, תוך חשיבה מחדש על האופן שבו הם מוצגים והמבנה הנוכחי שלהם.
מתודולוגיה וציר זמן אני רוצה לשפר את מסמכי התיעוד של Open Collective, על ידי עבודה לצד הקהילה כדי לקדם מחזורים של משוב רציף ממשך זמן שונה.
תקופת גיבוש של הקהילה (1 באוגוסט עד 1 בספטמבר 2019): היכרות עם קהילת Open Collective! לראיין חברים פעילים מפרויקטים מובילים ומתחילים, ולהציג להם שאלות לגבי מצב התיעוד הנוכחי (דוח מס' 1). רישום כל המערכות הפנימיות המשמשות למעקב אחר שאילתות ובעיות, ותהליך התיעוד שלהן ב-Open Collective Docs (דוח מס' 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 ב-Docs.
חומרים למסירה - עשרה דוחות ציבוריים לגבי הפעילויות שבוצעו - מדריך סגנון ציבורי ש-Open Collective וגם תורמים חיצוניים יכולים להשתמש בו - דפי תיעוד משתמש משופרים