השלב הנוכחי:
התוצאות יוכרזו
ציר הזמן.
אפשר להשתמש במדריך הזה כתבנית ליצירת ההצעה לפרויקט של הארגון.
PROPOSAL TITLE - שם הארגון
שם ההצעה צריך להיות קצר וספציפי. "עדכון המדריך לתורמים של ORGNAME" היא כותרת טובה להצעה. "שיפורים בתיעוד" מעורפל מדי; "עדכון סעיפים 5,7,23,99 במדריך לתורמים, יצירת שאלות נפוצות ויצירת מדריך סגנון" ארוך מדי.
מידע על הארגון
בקטע הזה ספרו לנו על הארגון או על הפרויקט שלכם בכמה פסקאות קצרות. איזו בעיה פותרת הפרויקט שלכם? מיהם המשתמשים והתורמים שלך? כמה זמן הארגון או הפרויקט שלך קיימים? חשוב לתת הקשר כדי לעזור לנו להבין למה מימון ההצעה עשוי להשפיע לטובה על קוד פתוח ובעולם.
Glorious Pickle (גרסה 1.2.3 הנוכחית, גרסה ראשונה ב-2009) היא ספרייה עם רישיון MIT שמאפשרת לחשב בקלות את היחס המושלם בין מלח, סוכר, חומץ ותבלינים לכל ירק שניתן לחמוצים בו, בכמויות שנעות מתינוק בודד מלפפון בודד ועד לאוניות צנון של תבשילי צנון. השותפים שלנו הם חובבי ירקות מכל העולם, והמשתמשים שלנו הם שפים ביתיים, שפים במסעדות ואנשים שעובדים בלוגיסטיקה של חברות וארגונים גדולים לעיבוד מזון. הארגון הגדול ביותר שלנו עוזר לבנקים למזון להפוך ירקות מן המדף הקצר שלהם לצנצנות יציבות של חמוצים, וכך להאכיל אנשים רעבים בקהילות רבות ולצמצם את פסולת המזון. בנוסף, המשתמשים שולחים לנו מדדים אופציונליים לגבי השימוש שלהם ב-Glorious Pickle, שבו אנחנו משתמשים כדי לייצר את PickleSet – מערך נתונים גדול שמשמש ליצירת מתכונים חדשים של מלפפונים חמוצים באמצעות למידת מכונה.
מידע על הפרויקט שלך
הבעיה בפרויקט
ספר לנו על הבעיה שהפרויקט שלך יעזור לפתור אותה. למה חשוב לארגון או לפרויקט שלך לפתור את הבעיה הזו?
המשתמשים רוצים אפשרות להוסיף לכלי Glorious Pickle מידע על תבלינים חדשים ומרכיבים אחרים (במיוחד מרכיבים ממטבחים לא אירופאיים). למרבה הצער, תהליך הוספת המידע הזה לא מתועד היטב, ומשמעות הדבר היא שתורמים פוטנציאליים צריכים לפתוח בעיה בפרויקט כדי לקבל עזרה (או שהם פשוט מוותרים לגמרי). במסגרת התהליך אנחנו מניחים גם שהשותפים ביצירת התוכן כבר מכירים את תהליך בקשת המשיכה שלנו ואת GitHub, למרות שרבים מהמשתמשים שלנו הם לא מפתחים מקצועיים.
ככל שיש לנו יותר מידע על המרכיבים, כך Glorious Pickle יהיה שימושי יותר לכל המשתמשים שלנו!
היקף הפרויקט
נשמח לשמוע אילו מסמכים הארגון שלך ייצור, יעדכן או ישפר. אם עבודה מסוימת לא מתבצעת בכוונה, יש לכלול גם את המידע הזה. יש לכלול הערכת זמן, ואם כבר זיהיתם מתנדבי הארגון וכותב טכני שיטפל בפרויקט שלכם.
פרויקט GloriousCollectionle (code-named PicklePlus) יבצע את הפעולות הבאות:
- בודקים את המסמכים הקיימים ויוצרים יומן חיכוך של התיעוד הנוכחי לשלושת התרחישים המובילים לדוגמה (הוספת רכיבים חדשים, הוספת רכיבים שונים ועדכון או תיקון מידע לגבי רכיבים מסוימים).
- בעזרת יומן החיכוך כמדריך להבנת הפערים בתיעוד, תוכלו ליצור תיעוד מעודכן לתרחישי השימוש המובילים.
- צרו "תקציר" מהיר שיעזור לתורמים חדשים לאסוף בקשות, ויעזרו להם ב-GitHub להשתמש בתהליך שלנו.
- לשלב משוב מבודקי המסמכים (מתנדבים בפרויקט) ומקהילת Glorious Pickle הרחבה יותר.
- עובדים עם צוות ההפצה כדי לעדכן את המסמכים באתר GloriousChoosele, וכדי ליצור תהליך לשמירת סנכרון התיעוד עם כלי העדכון מעכשיו והלאה.
עבודה שלא נכללת בהיקף הפרויקט הזה:
- הפרויקט הזה לא ייצור תהליך לקישור בין איותים שונים או שמות שונים של אותו רכיב.
- במסגרת הפרויקט הזה לא ייווצרו מדריכים ל-GitHub. התקציר יקשר לחומר קיים ורלוונטי ומועיל.
יש לנו שני מועמדים חזקים לכתיבה טכנית בפרויקט הזה, ואנחנו מעריכים שהשלמת העבודה הזו תארך שלושה חודשים. GloriousCollectionle PickleDocs SIG ו- @Glorious PicklePat (המתחזקת העיקרית של ממשק ה-API להוספת מרכיבים) התחייבו לתמוך בפרויקט.
מדידת ההצלחה של הפרויקט
איך תדעו שהתיעוד החדש עזר לפתור את הבעיה שלכם? באילו מדדים תשתמשו ואיך תוכלו לעקוב אחריהם?
Glorious Pickle מקבל בממוצע עשר בקשות שליפה ברבעון, להוספה או לעדכון של מרכיבים חדשים (מתויגים עם 'רכיב'). רוב בקשות המשיכה האלה (יותר מ-60%) מגיעות ממשתמשים קודמים. אנחנו סבורים שהתיעוד המשופר הזה יניב יותר בקשות משיכה ויותר בקשות משיכה מתורמים חדשים. מכיוון שרוב היוצרים הפעילים שלנו התחילו להוסיף מרכיבים, אנחנו חושבים גם ששיפור התיעוד הזה יוביל ליותר אנשים פעילים.
אנחנו נעקוב מדי חודש אחרי שני מדדים (מספר בקשות המשיכה שקשורות לרכיבים ומספר בקשות המשיכה מתורמים חדשים) אחרי פרסום התיעוד. בנוסף, אנחנו נעקוב אחרי מספר הכותבים שתרמו יותר משלוש תרומות בסך הכול, החל מרבעונים לאחר פרסום התיעוד.
אנחנו נחשיב את הפרויקט כמוצלח אם, לאחר פרסום התיעוד החדש:
- מספר בקשות המשיכה שקשורות לרכיבים גדל ב-20%
- מספר בקשות המשיכה מתורמים חדשים גדל ב-15%
- מספר התרומות שתרמו יותר מ-3 תכנים גדל ב-10% (מתחילת הרבעון שאחרי פרסום התיעוד)
ציר הזמן
כמה זמן זה ייקח לדעתך? יש לך אפשרות לחלק את המשימות של הכתיבה הטכנית לפי חודש/שבוע?
השלמת הפרויקט עצמו תימשך כחצי שנה. אחרי גיוס הכותבים הטכניים, אנחנו משקיעים חודש על כיוון הכותבים הטכניים, נעבור ליומן הביקורת והחיכוך ונתמקד ביצירת המסמכים במשך החודשים האחרונים.
| התאריכים | פעולות לביצוע |
|---|---|
| מאי | כיוון |
| יוני – אוגוסט | בדיקת המסמכים הקיימים ויצירת יומן חיכוך |
| ספטמבר עד אוקטובר | יצירת מסמכים |
| נובמבר | השלמת פרויקטים |
תקציב הפרויקט
הנחיות כלליות
- ניתן לכלול את התקציב בהצעה, או כקישור נפרד. אם התקציב כולל פחות מעשרה פריטים, מומלץ לכלול אותו בהצעה.
- כל התקציבים צריכים להיות בדולר ארה"ב. אנו צופים שהסכום ינע בין 5,000 ל-15,000 דולר ארה"ב. אם הפרויקט שלך לא נמצא בטווח הזה, עליך לספק מידע נוסף שיצדיק את התקציב.
- אנחנו צופים שרוב התקציב (60%-70% לפחות) יוקצה לכותב הטכני שעובד על הפרויקט. מומלץ להגדיר תקציב לכל פרויקט, כשהדבר אפשרי.
- אנחנו מצפים שפרויקטים של קוד פתוח ישתמשו ככל האפשר בכלים של קוד פתוח. אם לפרויקט שלך נדרשים כספים עבור רישיונות תוכנה קנייניים או תמיכה, יש לכלול הצדקה לסכום.
- הוצאות אפשריות אחרות כוללות:
- עיצוב עבודת העיצוב ליצירת מיתוג, סמלי לוגו, תבניות או נכסי עיצוב אחרים עבור אתר התיעוד שלך
- סכומים מינימליים (פחות מ-800 ש"ח) עבור פריטי גרפיקה ממותגים (חולצות או מדבקות למשתתפים). אם אתם משתמשים בלוגו של Docs בשם עונה, יש לצרף אליו את הלוגו או השם של הפרויקט או הארגון. המוצר שלך לא יכול להשתמש בשם Google.
- תשלומים מינימליים למתנדבים על תפקיד משמעותי של חונכות או הדרכה בפרויקט (אנחנו ממליצים לא לחרוג מ-500 $למתנדב, בבקשה)
- תרומות בהמשך לפרויקטים אחרים של קוד פתוח לא יהוו יותר מ-10% מסך כל התקציב שלכם.
- מוסיפים פריטי תקציב אחרים לפי הצורך, לצד הצדקה לסכום המבוקש. הצדקות הוצאות צריכות להדגיש את האופן שבו ההוצאה תתרום להצלחת הפרויקט באופן כללי.
תקציב לדוגמה
| פריט תקציב | Amount | סה"כ מצטבר | הערות/הצדקות |
|---|---|---|---|
| כותבים טכניים בודקים, מעדכנים, בודקים ומפרסמים מסמכים חדשים של תהליך הוספת רכיבים עבור Glorious Pickle | 5,000.00 | 5,000.00 | |
| מלגות למתנדבים | 500 | 6500.00 | 3 מלגות מתנדבים כפול 500 כל אחת |
| חולצות טי-שירט (10 חולצות) | 150.00 | 6,650.00 | |
| חד-קרן מתנפח ענק (גרסה 5 מטרים) | 99.99 | 6,749.99 | אנחנו ניתן את חד הקרן המתנפח לצוות שיענה על השאלות של הכותב הטכני הכי מהיר במהלך תקופת הפיתוח של הפרויקט |
| סה"כ | 6,749.99 |
מידע נוסף
כאן יש לכלול מידע נוסף שרלוונטי להצעה.
ניסיון קודם עם כותבים טכניים או מסמכים: אם אתם או אחד מהמנטורים שלכם עבדתם בעבר עם כותבים טכניים או אם פיתחתם מסמכים, ציינו זאת באפליקציה שלכם. תארו את התיעוד שיצרתם ואת הדרכים שבהן עבדתם עם הכותב הטכני. לדוגמה, תוכלו לתאר את תהליכי הבדיקה שהשתמשתם בהם, או איך כישורי הכותבים הטכניים הועילו לפרויקט שלכם. הסבירו איך הניסיון הקודם יכול לעזור לכם לעבוד עם כותבים טכניים בעונה של Docs.
השתתפות קודמת בעונה של Docs, Google Summer of Code או אחרים: אם אתם או אחד מהמנטורים שלכם השתתפתם ב-Google Summer of Code או בתוכנית דומה, ציינו זאת בטופס הבקשה שלכם. תיאור ההישגים שלכם בתוכנית הסבירו איך החוויה הזו עשויה להשפיע על אופן העבודה בעונה של Docs.