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

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

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

האם הארגון שלך יכול להשתתף בתוכנית 'עונה של תוכנית Docs'?

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

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

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

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

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

שלב החקירה

עונת הבקשות ל-Docs תיפתח ב-23 בפברואר 2022, אבל אנחנו ממליצים מאוד שארגונים יקדישו זמן כדי להשלים את השלבים של שלב הניתוח לפני שליחת הבקשה.

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

שלב הגשת הבקשה

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

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

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

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

• יש לשלוח את טופס הבקשה עד למועד האחרון להגשת הבקשה, 25 במרץ 2022 בשעה 18:00 (שעון UTC). ההצעות שאושרו יוכרזו ב-14 באפריל 2022.

פיתוח פרויקטים ודיווח עליהם

התחלת הפרויקט

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

מענק תשלומים

• החל מ-9 ביוני 2022, החל מ-9 ביוני 2022, במהלך תקופת Docs של Docs מופקד 40% מכספי המענק בחשבון Open Collective של כל ארגון. אנחנו ממליצים לארגונים ליצור תזמון תשלומים עם כותבים טכניים על סמך אבני דרך של הפרויקט, כולל תשלום בעת השקת הפרויקט.
• החל מ-14 בדצמבר 2022, 60% הנותרים יופקדו בחשבונות Open Collective של ארגונים שיבצעו זאת ויגישו את ההערכות הסופיות ואת המקרים לדוגמה שלהם. שימו לב: התשלום הסופי יתחיל ב-14 בדצמבר 2022 בכל הפרויקטים שעברו בהצלחה, ללא קשר ללוח הזמנים להשלמת הפרויקט (למשל, פרויקט של 3 חודשים לעומת 6 חודשים).
• למידע נוסף על יצירת חשבון Open Collective, עיינו במדריך התשלומים.

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

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

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

על הארגונים להשלים את ההערכה הסופית של הפרויקט ולשלוח את המקרה לדוגמה לפני 30 בנובמבר 2022 בשעה 18:00 UTC כדי לקבל את כספי המענק שנותרו.

הערכה סופית

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

מקרה לדוגמה

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

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

המקרה לדוגמה יפורסם ב-Seas of Docs, וחשוב לזכור אותו כשכוללים מידע על הפרויקט.

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

טפסים

טופס	קישור	תאריך יעד
אפליקציה של הארגון	בקשות הארגון נסגרו עכשיו. כדאי להצטרף לרשימת התפוצה של ההודעה בכתובת season-of-docs-announce באימייל.	25 במרץ 2022 בשעה 18:00 (UTC)
פרטי התשלום של הארגון	הטופס הזה עדיין לא זמין.	12 במאי 2022 בשעה 18:00 UTC
הוכחה לגבי העסקת כותב טכני	שלב הגיוס של כותבים טכניים הושלם.	16 במאי 2022 בשעה 18:00 UTC
הערכות חודשיות	שלב ההערכה החודשית נסגר.	הצגת ציר הזמן
הערכה של פרויקט הגמר ומקרה לדוגמה	שלב הערכת הפרויקט הסתיים.	30 בנובמבר 2022 בשעה 18:00 UTC
סקרי מעקב	הטופס זמין במהלך השלב של סקר המעקב (2 במאי 2023).	הצגת ציר הזמן

מידע קשור

• כדאי לעיין בציר הזמן של עונת Docs.