השלב הנוכחי:
תוכנית Docs לעונה של 2021 הסתיימה ב-14 בדצמבר 2021. להסבר על ציר הזמן
המדריך הזה מיועד לאדמינים ארגוניים שמגישים בקשה להצטרפות או משתתפים בעונה של תוכנית Docs לשנת 2021.
האם כדאי לארגון שלך להשתתף בתוכנית העונתית של תוכנית Docs 2021?
השאלות הבאות יעזרו לכם להבין אם פרויקט הקוד הפתוח או הארגון שלכם צריכים להשתתף בעונה של Docs.
האם הארגון או הפרויקט שלכם:
- חושבים שתיעוד חדש או מעודכן יעזור להשיג מטרה עסקית או לפתור בעיה בפרויקט או בקהילה שלכם?
- יש לכם הבנה ראשונית לגבי האופן שבו תוכלו למדוד את ההצלחה של פרויקט התיעוד שלכם?
- האם חברי הקהילה שמוכנים לעזור בגיוס, בהערכה ובקליטת כותב טכני, ושיהיו זמינים לענות על שאלות ולספק תמיכה נוספת במהלך הפרויקט (6-8 חודשים, כולל תקופת הגשת הבקשה)?
- האם חבר קהילה שמוכן לשמש כאדמין הארגון ולנהל את יצירת הבקשה, לענות על שאלות של מנהלי התוכנית ולשלוח הערכות חודשיות ואת ההערכה הסופית ובמקרה לדוגמה? בנוסף, מנהלי הארגון צריכים להיות מוכנים לענות על סקרים נוספים אחרי סיום עונת 2021 של Docs.
הארגון צריך גם לעמוד בדרישות הסף של התוכנית, כולל האפשרות ליצור חשבון Open Collective.
תהליך הגשת הבקשה של הארגון
שלב החקר
עונת 2021 של הגשת הבקשות ל-Docs תיפתח ב-9 בפברואר 2021, אבל אנחנו ממליצים מאוד לארגונים להשלים את השלבים של שלב הניתוח לפני שליחת הבקשה.
- יצירת דף הצעה לפרויקט. דף ההצעה כולל רשימת צרכים, יעדים או בעיות מרכזיים, פתרונות תיעוד אפשריים ומדדים אפשריים. הדף הזה צריך להיות ציבורי ולאפשר תרומה לקהילה ודיון. הוסיפו מידע לכותבים הטכניים שרוצים להשתתף – איפה כדאי להם לשאול שאלות, להביע עניין או לקבל מידע נוסף על הפרויקט שלכם? (תוכלו למצוא דוגמאות ברשימת הרעיונות לפרויקטים).
- פרסמו את דף ההצעה בערוצים של הקהילה והוסיפו את הארגון שלכם לרשימת הארגונים המתעניינים במאגר ה-GitHub של תקופת Docs. אפשר גם לשתף את הקישור בערוץ #week-of-docs בכתיבת The Docs Slack. דף קידום המכירות והעיתונות כולל סמלי לוגו ותכנים אחרים שאפשר להשתמש בהם כשמדברים על עונה של Docs.
- עבור כל רעיון תיעוד, כדאי לחשוב על הניסיון והכישורים הנדרשים לכותבים טכניים כדי לעבוד בהצלחה עם הקהילה והארגון שלכם. אילו מיומנויות הקהילה שלך תוכל לעזור לכותב טכני לפתח (לדוגמה, באמצעות GitHub או צרור הכלים שלך למסמכים)? (מומלץ לעיין במדריך לעבודה עם כותבים טכניים.
- בקשו ממתנדבים לענות על שאלות של כותבים טכניים מעוניינים.
- התחילו לבדוק הצהרות עניין שנשלחו מכותבים טכניים שמעוניינים לעבוד עם הפרויקט.
שלב הגשת הבקשה
- בחר את הרעיון המבטיח ביותר מדף ההצעה שלך. כל ארגון יכול להגיש הצעה אחת בלבד. כמה דברים שחשוב להביא בחשבון:
- איזה רעיון קיבל הכי הרבה עניין בקרב כותבים טכניים?
- איזה רעיון יעזור לפתור את הבעיה הגדולה ביותר של הפרויקט שלכם? עדיף לבחור רעיון מסוכן שיש לו השפעה גדולה יותר מאשר רעיון שיש לו סיכוי גבוה יותר להסתיים, אבל לא ישפיע באופן משמעותי על הפרויקט.
- האם הרעיון מחייב השתתפות של חברים ספציפיים בקהילה? יש להם זמן להשתתף?
צור את ההצעה שלך באמצעות התבנית להצעה. חשוב להבין את המידע ולכלול את הפרטים הבאים:
- הבעיה שאתם רוצים לטפל בה
- היקף המסמכים שברצונך לשפר או ליצור
- איך מודדים את הצלחת המסמכים
ההצעה חייבת לכלול גם תקציב. הצעות שלא הושלמו לא יובאו בחשבון.
צריך לשלוח את טופס הבקשה עד למועד האחרון להגשת בקשה, 26 במרץ 2021, בשעה 18:00 UTC. ההצעות שאושרו יפורסמו ב-16 באפריל 2021.
פיתוח פרויקטים ודיווח עליהם
התחלת הפרויקט
- אם הארגון שלכם כבר בחר כותבים או כותבים טכניים לפרויקט, עורכים פגישת פתיחה עם הכותב הטכני. כדאי לשתף פעולה עם הכותב הטכני כדי ליצור לוח זמנים לעבודה ובדיקות סדירות.
- אם קיבלתם מספר הצהרות עניין מכותבים טכניים מעוניינים, עליכם לפרסם הודעה פומבית לגבי בחירת הכותבים הטכניים שלכם או להודיע למגישי הבקשות על החלטתכם באופן אחר.
תשלומים למענקים
- החל מ-10 ביוני 2021, בעונה של Docs תתבצע הפקדה של 40% מכספי המענק בחשבון Open Collective של כל ארגון, לאחר המעסיק כותב טכני. אנחנו ממליצים לארגונים ליצור תזמון תשלומים עם כותבים טכניים על סמך אבני דרך של הפרויקט, כולל תשלום כשמתחילים את הפרויקט.
- 60% הנותרים יופקדו בחשבונות Open Collective של ארגונים שישלימו ושולחים את ההערכות והמקרים לדוגמה הסופיים שלהם, החל מ-14 בדצמבר 2021.
- מידע נוסף על יצירת חשבון Open Collective זמין במדריך התשלומים.
דיווח על סטטוס פרויקט
- מנהלי מערכת בארגון אמורים למלא את דוחות הסטטוס החודשיים תוך שבוע מרגע קבלת הקישור לטופס דוח הסטטוס (הקישור יישלח באימייל, לכן כדאי לבדוק בתיקיית הספאם).
הערכה סופית של פרויקט ומקרה לדוגמה
על הארגונים להשלים ולשלוח גם את ההערכה הסופית של הפרויקט וגם את המקרה לדוגמה לפני 30 בנובמבר 2021 בשעה 18:00 UTC כדי לקבל את כספי המענק הנותרים.
ההערכה הסופית
טופס ההערכה הסופי יהיה זמין לאדמינים ארגוניים לא פחות מחודש לפני 30 בנובמבר 2021 בשעה 18:00 לפי שעון UTC.
מקרה לדוגמה
המקרה לדוגמה של עונה של Docs הוא המסר המרכזי של השתתפות הארגון בעונת Docs 2021. ניהול יומן שבועי של עדכוני פרויקטים יעזור לכם ליצור מקרה לדוגמה. בכל שבוע מתעדים את ההתקדמות בפרויקט (כולל קישורים לשליפת בקשות, בעיות או שיחות, אם הם מועילים), מה היה טוב (או לא), מה למדתם ושאלות שנשאלו.
לקבלת מידע נוסף, קראו את המאמר יצירת מקרה לדוגמה והשתמשו בתבנית לדוגמה כדי ליצור מקרה לדוגמה. עליכם לשלוח את המקרה לדוגמה כקישור בטופס ההערכה הסופי.
המקרה לדוגמה יפורסם בעונת המסמכים של Docs, לכן חשוב לזכור אותו כשכוללים מידע על הפרויקט.
אנחנו דורשים מארגונים להשתתף לפחות בשלושה סקרים המשך כדי לעזור לנו לעקוב אחר הצלחת הפרויקטים ב-Docs לאורך זמן.
טפסים
| טופס | קישור | תאריך יעד |
|---|---|---|
| בקשה מטעם הארגון | הבקשות של הארגון סגורות עכשיו. כדאי להצטרף לרשימת התפוצה של ההודעה בכתובת season-of-docs-announce כדי להתעדכן. |
26 במרץ 2021 בשעה 18:00 (UTC) |
| פרטי התשלום של הארגון | 12 במאי 2021 בשעה 18:00 (שעון UTC) | |
| הוכחה לגיוס של כותב טכני | 17 במאי 2021 בשעה 18:00 (שעון UTC) | |
| הערכות חודשיות | הטופס זמין במהלך שלב הערכת הפרויקט (5 ביוני 2024). |
הצגת ציר הזמן |
| הערכת פרויקט סיום ומקרה לדוגמה | הטופס זמין במהלך שלב הערכת הפרויקט הסופי ומקרה לדוגמה (22 בנובמבר 2024 עד 10 בדצמבר 2024). |
30 בנובמבר 2021 בשעה 18:00 (UTC) |
| סקרים למעקב | הטופס זמין במהלך השלב של סקר המעקב (1 במאי 2025). |
הצגת ציר הזמן |
מידע קשור
- קוראים את ציר הזמן של עונת Docs.