השלב הנוכחי:
סיום הפרויקט. ציר הזמן
אפשר להשתמש במדריך הזה כתבנית ליצירת הצעת הפרויקט של הארגון.
שם ההצעה – שם הארגון
הכותרת של ההצעה צריכה להיות קצרה וספציפית. 'עדכון מדריך התורמים של ORGNAME' היא כותרת טובה להצעה. 'שיפורים במסמכי העזרה' הוא תיאור לא ברור מדי,ו'עדכון קטעים 5, 7, 23, 99 במדריך לתורמים, יצירת שאלות נפוצות ויצירת מדריך סגנון' הוא ארוך מדי.
מידע על הארגון
בסעיף הזה, עליכם לספר לנו על הארגון או הפרויקט שלכם בכמה פסקאות קצרות. איזו בעיה הפרויקט שלכם פותר? מי המשתמשים והתורמים שלכם? כמה זמן הארגון או הפרויקט קיימים? כדאי להוסיף הקשר כדי לעזור לנו להבין למה מימון הבקשה שלכם יביא להשפעה חיובית בקוד פתוח ובעולם.
GloriousPickle (הגרסה הנוכחית היא 1.2.3, הגרסה הראשונה שוחררה ב-2009) היא ספרייה ברישיון MIT שמאפשרת לחשב בקלות את היחס המושלם של מלח, סוכר, חומץ ותבלינים לכל ירק שאפשר לכבוש, בכמויות שונות, החל ממלון אחד של מלפפון קטן ועד ספינות מכולות של צנוניות. צוות התורמים שלנו כולל חובבי מלפפונים חמוצים מכל רחבי העולם, והמשתמשים שלנו הם שפים ביתיים, שפים במסעדות ואנשים שעובדים בלוגיסטיקה של חברות גדולות לעיבוד מזון וארגונים. המשתמש הגדול ביותר שלנו הוא ארגון שעוזר למרכזי מזון להפוך ירקות עם חיי מדף קצרים לצנצנות של מלפפונים חמוצים, כדי לעזור להאכיל אנשים רעבים בקהילות רבות ולצמצם את בזבוז המזון. בנוסף, המשתמשים שולחים לנו מדדים אופציונליים לגבי השימוש שלהם ב-GloriousPickle, שאנחנו משתמשים בהם כדי ליצור את PickleSet – מערך נתונים גדול ליצירת מתכונים חדשים של מלפפונים חמוצים באמצעות למידת מכונה.
מידע על הפרויקט
הבעיה בפרויקט
ספרו לנו על הבעיה שהפרויקט יעזור לפתור. למה חשוב לארגון או לפרויקט שלכם לפתור את הבעיה הזו?
המשתמשים רוצים להוסיף מידע על תבלינים חדשים ועל מרכיבים אחרים (במיוחד מרכיבים ממטבחים לא אירופאיים) לכלי GloriousPickle. לצערנו, התהליך להוספת המידע הזה לא מתועד בצורה טובה, ולכן שותפים פוטנציאליים צריכים לפתוח פנייה בפרויקט כדי לקבל עזרה (או פשוט מוותרים לגמרי). התהליך גם מבוסס על ההנחה שהשותפים כבר מכירים את תהליך בקשת המשיכה ואת GitHub, למרות שרבים מהמשתמשים שלנו הם לא מפתחים מקצועיים.
ככל שיש לנו יותר מידע על המרכיבים, כך GloriousPickle שימושי יותר לכל המשתמשים שלנו.
היקף הפרויקט
יש לציין אילו מסמכים הארגון שלכם ייצור, יעדכן או ישפר. אם יש עבודות שלא מתבצעות בכוונה, יש לכלול גם את המידע הזה. כדאי לציין אומדן זמן, ולציין אם כבר זיהית מתנדבים בארגון וכותב טכני שיעבדו על הפרויקט.
הפרויקט GloriousPickle (הכינוי שלו הוא PicklePlus) יעשה את הפעולות הבאות:
- בודקים את המסמכים הקיימים ויוצרים יומן חיכוך של המסמכים הנוכחיים לגבי שלושת התרחישים הנפוצים ביותר לשימוש (הוספת מרכיב חדש, הוספת מרכיב וריאנט ועדכון או תיקון של מידע על מרכיב).
- בעזרת יומן החיכוכים, תוכלו להבין את הפערים במסמכי העזרה וליצור מסמכי עזרה מעודכנים לתרחישים לדוגמה הנפוצים ביותר.
- כדאי ליצור 'סיכום מהיר' כדי לעזור לאנשים חדשים ב-GitHub ובבקשות משיכה להשתמש בתהליך שלנו.
- שילוב משוב מבודקי מסמכי העזרה (מתנדבים בפרויקט) ומקהילת GloriousPickle הרחבה.
- עבודה עם צוות ההשקה כדי לעדכן את המסמכים באתר GloriousPickle, וליצור תהליך ששומר על סנכרון בין המסמכים לבין כלי העדכון.
עבודה שלא נכללת בהיקף הפרויקט הזה:
- הפרויקט הזה לא יוצר תהליך לקישור בין שיטות איות או שמות שונים של אותו מרכיב.
- במסגרת הפרויקט לא נוצרים מדריכים ב-GitHub. במקום זאת, גיליון העזר יכלול קישורים למאמרים קיימים שיכולים לעזור לכם.
יש לנו שני מועמדים מוכשרים לכתיבה טכנית לפרויקט הזה, וההערכה שלנו היא שהעבודה תתבצע תוך שלושה חודשים. צוות GloriousPickle PickleDocs SIG ו- @GloriousPicklePat (מנהל הליבה של ה-API להוספת מרכיבים) התחייבו לתמוך בפרויקט.
מדידת ההצלחה של הפרויקט
איך תדעו שהמסמך החדש עזר לכם לפתור את הבעיה? באילו מדדים תשתמשו ואיך תעקבו אחריהם?
ב-GloriousPickle מקבלים בממוצע עשר בקשות משיכה (pull request) בכל רבעון להוספה או לעדכון של מרכיבים חדשים (שסומנו בתג 'ingredient'). רוב בקשות ה-pull (יותר מ-60%) מגיעות מאנשים שתרמו בעבר. אנחנו מאמינים שהתיעוד המשופר הזה יוביל ליותר בקשות משיכה, וגם ליותר בקשות משיכה מאנשים חדשים שיצטרפו לפרויקט. רוב התורמים הפעילים שלנו התחילו להוסיף מרכיבים, ולכן אנחנו גם סבורים ששיפור המסמכים האלה יוביל ליותר תורמים פעילים באופן כללי.
אחרי פרסום המסמכים, נתחיל לעקוב אחרי שני מדדים (מספר בקשות משיכה שקשורות למרכיבים ומספר בקשות משיכה ממשתתפים חדשים) מדי חודש. בנוסף, נתחיל לעקוב אחרי מספר התורמים ששלחו יותר משלושה פריטים בסה"כ, החל מרבעון לאחר פרסום המסמכים.
נחשב את הפרויקט למוצלח אם, אחרי פרסום המסמכים החדשים:
- עלייה של 20% במספר בקשות המשיכה שקשורות למרכיבים
- מספר בקשות המשיכה (pull requests) של שותפים חדשים בפרויקט גדל ב-15%
- מספר התורמים ששלחו יותר מ-3 תרומות יגדל ב-10% (החל מהרבעון שאחרי פרסום המסמכים)
ציר הזמן
כמה זמן לדעתך ייקח לבצע את העבודה הזו? יש לך אפשרות לפרט את המשימות של הכותבים הטכניים לפי חודש או שבוע?
השלמת הפרויקט עצמו צפויה להימשך כ-6 חודשים. אחרי שנתקבל את הסופר הטכני, נקדיש חודש להדרכה שלו, אחר כך נעבור לבדיקות וליומן החיכוכים, ובחודשים האחרונים נתמקד ביצירת המסמכים.
| התאריכים | פעולות לביצוע |
|---|---|
| מאי | כיוון |
| יוני – אוגוסט | בדיקת המסמכים הקיימים ויצירת יומן חיכוך |
| ספטמבר עד אוקטובר | יצירת מסמכי עזר |
| נובמבר | השלמת הפרויקט |
תקציב הפרויקט
הנחיות כלליות
- אתם יכולים לכלול את התקציב בהצעה או כקישור נפרד. אם התקציב שלכם כולל פחות מעשרה פריטים, מומלץ לכלול אותו בהצעה.
- כל התקציבים צריכים להיות בדולר ארה"ב. אנחנו מצפים שהמענקים ינועו בין 5,000$ל-15,000$. אם הפרויקט שלכם יחרוג מהטווח הזה, תצטרכו לספק מידע נוסף כדי להצדיק את התקציב.
- אנחנו מצפים שרוב התקציב (60-70% לפחות) יוקצה לכותב הטכני שעובד על הפרויקט שלכם. מומלץ להקצות תקציב לכל פרויקט בנפרד, כשהדבר אפשרי.
- אנחנו מצפים שפרויקטים בקוד פתוח ישתמשו בכלים של קוד פתוח כשהדבר אפשרי. אם הפרויקט שלכם דורש לחלוטין כספים לרישיונות או לתמיכה בתוכנות קנייניות, עליכם לכלול הצדקה לסכום.
- הוצאות אפשריות נוספות כוללות:
- עבודות עיצוב ליצירת מיתוג, לוגואים, תבניות או נכסי עיצוב אחרים לאתר התיעוד
- סכומים מינימליים (פחות מ-200$) למתנות לפרויקט (חולצות או מדבקות למשתתפים). אם אתם משתמשים בלוגו של Google Season of Docs, עליכם לציין לידו את השם או הלוגו של הפרויקט או הארגון שלכם. אסור להשתמש בשם Google בפרסים.
- תשלומים מינימליים למתנדבים שממלאים תפקידים משמעותיים של הדרכה או ליווי בפרויקט (מומלץ לא יותר מ-500 $לכל מתנדב)
- תרומות לפרויקטים אחרים בקוד פתוח לא יכולות לחרוג מ-10% מסך התקציב.
- מומלץ לכלול פריטים אחרים בתקציב לפי הצורך, יחד עם נימוקים לסכום המבוקש. בהצדקות להוצאות צריך להדגיש איך ההוצאה תתרום להצלחת הפרויקט בכללותו.
תקציב לדוגמה
| פריט תקציב | סכום | סכום מצטבר | הערות/נימוקים |
|---|---|---|---|
| בודק טכני מבצע ביקורת, עדכון, בדיקה ופרסום של תיעוד חדש של תהליך הוספת המרכיבים ל-GloriousPickle | 5,000.00 | 5,000.00 | |
| מענקים למתנדבים | 500 | 6,500.00 | 3 מענקי התנדבות בסך 500 ש"ח כל אחד |
| חולצות טישרט של הפרויקט (10 חולצות) | 150.00 | 6,650.00 | |
| חד-קרן מתנפח ענק (גרסה באורך 4.5 מטרים) | 99.99 | 6749.99 | נעניק את החד-קרן הנפוח לצוות שתשובותיו לשאלות של הכותבים הטכניים יהיו המהירות ביותר במהלך תקופת הפיתוח של הפרויקט |
| סה"כ | 6749.99 |
מידע נוסף
כאן אפשר לציין מידע נוסף שרלוונטי להצעה.
ניסיון קודם בעבודה עם סופרים טכניים או ביצירת מסמכי עזרה: אם אתם או אחד מהמנחים שלכם עבדו בעבר עם סופרים טכניים או פיתחתם מסמכי עזרה, כדאי לציין זאת בבקשה. מתארים את המסמכים שיצרתם ואת האופן שבו עבדת עם הכותבים הטכניים. לדוגמה, תוכלו לתאר את תהליכי הבדיקה שבהם השתמשתם, או איך הכישורים של הסופר הטכני עזרו לכם בפרויקט. הסבירו איך הניסיון הקודם הזה יכול לעזור לכם לעבוד עם סופר טכני במסגרת Google Season of Docs.
השתתפות קודמת בתוכניות Google Season of Docs, Google Summer of Code או תוכניות אחרות: אם אתם או אחד מהמנחים שלכם השתתפתם בתוכנית Google Summer of Code או בתוכנית דומה, כדאי לציין זאת בבקשה. מתארים את ההישגים שלכם בתוכנית הזו. הסבירו איך החוויה הזו עשויה להשפיע על האופן שבו אתם עובדים ב-Google Season of Docs.