מדריך למנהל מערכת בארגון

השלב הנוכחי:
התוצאות פורסמו. ציר הזמן

המדריך הזה מיועד לאדמינים ארגוניים שמגישים בקשה להשתתף בתוכנית Google Season of Docs או משתתפים בה.

האם כדאי לארגון שלכם להשתתף בתוכנית Google Season of Docs?

השאלות הבאות יעזרו לכם להבין אם הפרויקט או הארגון שלכם בקוד פתוח צריכים להשתתף ב-Google Season of Docs.

האם הארגון או הפרויקט שלכם:

  • לדעתכם מסמכי עזרה חדשים או מעודכנים יעזרו לכם להשיג יעד או לפתור בעיה בפרויקט או בקהילה שלכם?
  • יש לכם הבנה ראשונית או היפותזה לגבי האופן שבו תמדדו את הצלחת פרויקט התיעוד?
  • האם יש חברי קהילה שמוכנים לעזור בגיוס, בהערכה ובהטמעה של כותב טכני, ויהיו זמינים לענות על שאלות ולספק תמיכה אחרת במהלך הפרויקט (6-8 חודשים, כולל תקופת הגשת הבקשות)?
  • האם יש לכם חבר קהילה שיסכים לשמש כאדמין הארגון ולתאם את יצירת הבקשה, את המענה על השאלות של מנהלי התוכנית ואת שליחת הבדיקות החודשיות, הבדיקה הסופית ודוח המחקר? האדמין של הארגון צריך גם להיות מוכן לענות על סקרים למעקב אחרי סיום התוכנית 'עונת Google Docs'.

הארגון צריך גם לעמוד בדרישות הסף של התוכנית, כולל היכולת ליצור חשבון Open Collective.

תהליך הגשת הבקשה של הארגון

שלב הניתוח

התוכנית 'עונת המסמכים של Google' תפתח ב-15 בפברואר 2023, אבל מומלץ מאוד לארגונים להקדיש זמן כדי להשלים את השלבים בשלב הבדיקה לפני שליחת הבקשה.

  • יוצרים דף של הצעת פרויקט. בדף ההצעה מופיעה רשימה של צרכים, מטרות או בעיות מרכזיים, פתרונות אפשריים לתיעוד ומדדים אפשריים. הדף הזה צריך להיות גלוי לכולם, ולאפשר לאנשים מהקהילה לתרום תוכן ולנהל דיון. כדאי לכלול מידע עבור סופרים טכניים שרוצים להשתתף – איפה הם יכולים לשאול שאלות, להביע עניין או לקבל מידע נוסף על הפרויקט? מומלץ להוסיף כתובת אימייל ליצירת קשר עם הארגון שלכם בקוד פתוח בנוגע ל-Google Season of Docs. עם זאת, מומלץ מאוד לא להשתמש בכתובת אימייל אישית ככתובת האימייל ליצירת קשר עם הארגון שלכם בקוד פתוח. (כאן אפשר למצוא דוגמאות לרעיונות לפרויקטים).
  • כדאי לפרסם את דף ההצעה בערוצי הקהילה שלכם ולהוסיף את הארגון שלכם לרשימת הארגונים המעוניינים במאגר GitHub של Google Season of Docs. אפשר גם לשתף את הקישור בערוץ #season-of-docs ב-Write The Docs Slack. דף הקידום והעיתונות כולל סמלי לוגו ותוכן אחר שאפשר להשתמש בו כשמדברים על 'עונת המסמכים של Google'.
  • לכל רעיון למסמך, כדאי לחשוב על הניסיון והכישורים הנדרשים לכותב טכני כדי לעבוד בצורה מוצלחת עם הקהילה והארגון שלכם. אילו מיומנויות הקהילה שלכם יכולה לעזור לכותב טכני לפתח (לדוגמה, שימוש ב-GitHub או בכלי הפיתוח של מסמכי העזרה)? (כאן מוסבר איך עובדים עם סופרים טכניים).
  • בקשו מתנדבים לענות על שאלות של כותבים טכניים מעוניינים.
  • מתחילים לבדוק את הצהרות העניין שנשלחו על ידי כותבים טכניים שרוצים לעבוד בפרויקט שלכם.

שלב הבקשה

  • בוחרים את הרעיון הכי מבטיח מדף ההצעה. כל ארגון יכול לשלוח רק הצעה אחת. כמה דברים שכדאי להביא בחשבון:
    • איזו רעיון עורר הכי הרבה עניין בקרב הכותבים הטכניים?
    • איזו רעיון יעזור לכם לפתור את הבעיה הגדולה ביותר בפרויקט? עדיף לבחור רעיון מסוכן יותר שיש לו השפעה גדולה יותר, מאשר רעיון לפרויקט תיעוד שיש סיכוי גבוה יותר להשלים אותו אבל לא ישנה באופן משמעותי את הפרויקט.
    • האם הרעיון דורש השתתפות של חברים ספציפיים בקהילה? האם יש להם זמן להשתתף?

  • יוצרים את ההצעה באמצעות תבנית ההצעה. חשוב להבין את הפרטים הבאים ולכלול אותם בבקשה:

    • הבעיה שרוצים לטפל בה
    • היקף המסמך שרוצים לשפר או ליצור
    • איך תמדדו את ההצלחה של התיעוד

    ההצעה צריכה לכלול גם תקציב. לא נבדוק הצעות חלקיות.

  • שולחים את טופס הבקשה עד למועד האחרון להגשת בקשות, 24 במרץ 2023 בשעה 18:00 (שעון UTC). ההצעות שאושרו יפורסמו ב-31 במרץ 2023.

פיתוח פרויקטים ודיווח

יציאה לדרך של פרויקט

  • אם בארגון שלכם כבר בחרתם סופר/ת טכני/ת לפרויקט, כדאי לקיים פגישה ראשונית עם הסופר/ת הטכני/ת. כדאי לשתף פעולה עם הכותבים הטכניים כדי ליצור לוח זמנים לעבודה ולבצע בדיקות שוטפות.
  • אם קיבלתם כמה הצהרות עניין ממגישים מתעניינים, כדאי להודיע באופן ציבורי על הבחירה שלכם בכותב טכני או להודיע על ההחלטה שלכם למגישים בדרך אחרת.

תשלומי מענקים

  • Google Season of Docs תפקיד 40% מסכום המענק בחשבון Open Collective של כל ארגון אחרי שהארגון יקבל כותב טכני, החל מ-7 ביוני 2023. מומלץ לארגונים ליצור לוח זמנים לתשלומים עם הכותבים הטכניים על סמך אבני דרך בפרויקט, כולל תשלום בתחילת הפרויקט.
  • 60% הנותרים יופקדו בחשבונות Open Collective של ארגונים שישלימו וישלחו את הבדיקות הסופיות ואת מקרי המחקר שלהם, החל מ-5 בדצמבר 2023. לתשומת ליבך, כל הפרויקטים שהושלמו, ללא קשר ללוחות הזמנים להשלמת הפרויקטים (למשל, פרויקט של 3 חודשים לעומת פרויקט של 6 חודשים), יתחילו לקבל תשלום סופי ב-5 בדצמבר 2023.
  • במדריך התשלומים מוסבר בהרחבה איך יוצרים חשבון ב-Open Collective.

דיווח על סטטוס הפרויקט

  • האדמינים של הארגון צריכים למלא את דוחות הסטטוס החודשיים תוך שבוע ממועד קבלת הקישור לטופס דוח הסטטוס (הקישור יישלח באימייל, לכן יש לבדוק בתיקיית הספאם).

הערכה סופית של הפרויקט ודוח מקרה לדוגמה

כדי לקבל את יתרת סכום המענק, הארגונים צריכים להשלים ולשלוח את הבדיקה הסופית של הפרויקט ואת ניתוח המקרה לפני 21 בנובמבר 2023 בשעה 18:00 (שעון UTC).

הערכה סופית

טופס הבדיקה הסופי יהיה זמין לאדמינים של הארגון לפחות חודש לפני 21 בנובמבר 2023 בשעה 18:00 (שעון UTC).

מקרה לדוגמה

מקרה המחקר של Google Season of Docs הוא המסמך העיקרי שצריך להגיש כחלק מהשתתפות הארגון ב-Google Season of Docs. כדאי לנהל יומן שבועי של עדכוני הפרויקט כדי שתוכלו ליצור את ניתוח המקרה. בכל שבוע, תיעוד של התקדמות הפרויקט (כולל קישורים לבקשות משיכה, לבעיות או לשיחות, במקרים הרלוונטיים), מה הלך טוב (או לא טוב), מה למדתם ושאלות שנשאלו.

למידע נוסף, אפשר לקרוא את המאמר יצירת מקרה לדוגמה. חשוב לפעול לפי התבנית שלנו למקרה לדוגמה כדי ליצור את המקרה לדוגמה. עליכם לשלוח את ניתוח המקרה כקישור בטופס הערכה הסופי.

ניתוח המקרה שלכם יפורסם באתר של Google Season of Docs, לכן חשוב לזכור זאת כשאתם מוסיפים מידע על הפרויקט.

אנחנו דורשים מהארגונים להשתתף לפחות בשלושה סקרים עוקבים כדי לעזור לנו לעקוב אחרי ההצלחה של הפרויקטים של Google Season of Docs לאורך זמן.

טפסים

טופס קישור תאריך יעד
בקשת הצטרפות של ארגון

האפליקציות של הארגון סגורות עכשיו. כדי להתעדכן, כדאי להצטרף לרשימת התפוצה של ההודעות בכתובת season-of-docs-announce.

 24 במרץ 2023 בשעה 18:00 (שעון UTC)
פרטי התשלום של הארגון

השלמת השלב של פרטי התשלום של הארגון. אם אתם צריכים לבצע שינויים בפרטי התשלום של הארגון, תוכלו לפנות לאדמינים של Season of Docs.

 3 במאי 2023 בשעה 18:00 (שעון UTC)
הוכחה לכך ששכרתם סופר טכני

שלב הגיוס של סופר טכני הושלם.

 10 במאי 2023 בשעה 18:00 (שעון UTC)
הערכות חודשיות

שלב הבדיקה החודשי נסגר.

 ציר הזמן
הערכה סופית של הפרויקט ודוח מקרה

שלב הערכת הפרויקט נסגר.

 21 בנובמבר 2023 בשעה 18:00 (שעון UTC)
סקרים עוקבים

הטופס יהיה זמין במהלך השלב של הסקרים הבאים (1 במאי 2025).

 ציר הזמן