השלב הנוכחי:
פיתוח המסמכים. להסבר על ציר הזמן
אפשר להשתמש במדריך הזה כתבנית ליצירת הצעה לפרויקט של הארגון.
PROPOSAL TITLE – שם הארגון
הכותרת של ההצעה צריכה להיות קצרה וספציפית. "עדכון המדריך לתורמים של 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 מקבלת בממוצע עשר בקשות משיכה ברבעון להוספה או לעדכון מרכיבים חדשים ('רכיב'). רוב בקשות המשיכה האלה (יותר מ-60%) מגיעות ממשתמשים קודמים. אנחנו סבורים שהתיעוד המשופר הזה יגרום ליותר בקשות משיכה וליותר בקשות משיכה מתורמים חדשים. מאחר שרוב השותפים הפעילים שלנו התחילו להוסיף מרכיבים, אנחנו חושבים גם ששיפור התיעוד הזה יכול להוביל לעלייה במספר הכולל של תורמים פעילים.
אנחנו נעקוב אחרי שני מדדים (מספר בקשות המשיכה שקשורות למרכיבים ומספר בקשות המשיכה מתורמים חדשים) מדי חודש אחרי פרסום התיעוד. כמו כן, נעקוב אחר מספר האנשים שתרמו יותר משלושת תוכן בסך הכול, החל מרבעון לאחר פרסום התיעוד.
אנחנו נתייחס לפרויקט כמוצלח אם, לאחר פרסום התיעוד החדש:
- מספר בקשות המשיכה שקשורות לרכיבים גדל ב-20%
- מספר בקשות המשיכה מתורמים חדשים גדל ב-15%
- מספר תורמי התוכן שתרמו יותר מ-3 תכנים גדל ב-10% (בתחילת הרבעון שאחרי פרסום התיעוד).
ציר הזמן
כמה זמן צפוי להימשך העבודה הזו? יש לך אפשרות לחלק את המשימות של כותבים טכנולוגיים לפי חודש או שבוע?
השלמת הפרויקט עצמו תימשך כחצי שנה. אחרי הקליטה של הכותב הטכנולוגי, אנחנו משקיעים חודש בניהול הכותבים הטכנולוגיים, ולאחר מכן נעבור ליומן הביקורת והחיכוך ונקדישים את החודשים האחרונים ליצירת התיעוד.
| התאריכים | פעולות לביצוע |
|---|---|
| מאי | כיוון |
| יוני – אוגוסט | ביקורת מסמכים קיימים ויצירת יומן חיכוך |
| ספטמבר עד אוקטובר | יצירת מסמכים |
| נובמבר | השלמת הפרויקט |
תקציב הפרויקט
הנחיות כלליות
- ניתן לכלול את התקציב בהצעה או כקישור נפרד. אם התקציב קטן מעשרה פריטים, מומלץ לכלול אותו בהצעה.
- כל התקציבים צריכים להיות בדולר ארה"ב. אנו צופים שמענקים נעים בין 5,000 דולר ארה"ב ל-15,000 דולר ארה"ב. אם הפרויקט שלכם נמצא מחוץ לטווח זה, ספקו מידע נוסף שיצד את התקציב שלכם.
- אנחנו צופים שחלק גדול מהתקציב (מינימום 60%-70%) יוקצה לכותב הטכני שעובד על הפרויקט. מומלץ להגדיר תקציב לכל פרויקט בנפרד, במידת האפשר.
- אנחנו מצפים שפרויקטים של קוד פתוח ישתמשו ככל האפשר בכלים של קוד פתוח. אם הפרויקט שלך אכן דורש כסף עבור רישיונות תוכנה קנייניים או תמיכה, יש לכלול הצדקה לסכום.
- הוצאות אפשריות אחרות כוללות:
- עיצוב עבודות כדי ליצור מיתוג, סמלי לוגו, תבניות או נכסי עיצוב אחרים עבור אתר התיעוד שלך
- סכומים מינימליים (פחות מ-800 ש"ח) תמורת פריטים שונים במסגרת פרויקט (חולצות או מדבקות למשתתפים). אם אתם משתמשים בלוגו של Google Docs לעונה, צריך לצרף אליו את הלוגו או השם של הפרויקט או הארגון. המוצרים שלך לא כוללים את השם Google.
- תשלומים מינימליים למתנדבים שלוקחים חלק משמעותי בתפקידי חונכות או הדרכה בפרויקט (אנחנו ממליצים לא לחרוג מ-500 $לכל מתנדב, בבקשה)
- תרומות בהמשך לפרויקטים אחרים של קוד פתוח לא יכולות לחרוג מ-10% מסך התקציב הכולל.
- כוללים פריטי תקציב אחרים לפי הצורך, לצד ההצדקה לסכום המבוקש. ההצדקה להוצאות צריכה להדגיש איך ההוצאה תתרום להצלחת הפרויקט כולו.
תקציב לדוגמה
| פריט תקציב | Amount | סה"כ מצטבר | הערות/הצדקות |
|---|---|---|---|
| בודקים טכניים של כותבים, מעדכנים, בודקים ומפרסמים מסמכים חדשים לגבי תהליך ההוספה של מרכיבים ל-GloriousPickle | 5,000.00 | 5,000.00 | |
| מלגות להתנדבות | 500 | 6,500.00 | 3 מלגות למתנדבים x 500 כל אחת |
| חולצות טי-שירט (10 חולצות) | 150.00 | 6650.00 | |
| חד-קרן מתנפח ענק (גרסה של 5 מטרים) | 99.99 | 6,749.99 | אנו נספק את חד-קרן המתנפח לצוות שיענה על השאלות של הכותב הטכני בצורה המהירה ביותר במהלך תקופת הפיתוח של הפרויקט |
| סה"כ | 6,749.99 |
מידע נוסף
יש לכלול כאן כל מידע נוסף שרלוונטי להצעה שלכם.
ניסיון קודם עם כותבים טכניים או מסמכים: אם אתם או אחד מהחונכים שלכם עבדתם בעבר עם כותבים טכניים או אם פיתחתם מסמכים, ציינו זאת באפליקציה שלכם. תארו את המסמכים שיצרתם ואת הדרכים שבהן עבדתם עם הכותב הטכני. לדוגמה, תארו כל תהליך בדיקה שהשתמשתם בו, או איך הכישורים של הכותב הטכני הועילו לפרויקט שלכם. הסבירו איך החוויה הקודמת יכולה לעזור לכם לעבוד עם כותבים טכניים בעונה של Docs ב-Google.
השתתפות קודמת בעונה של Docs, Google Summer of Code או אחרים: אם אתם או אחד מהחונכים שלכם השתתפתם ב-Google Summer of Code או בתוכנית דומה, ציינו זאת בטופס הבקשה שלכם. תיאור ההישגים שלכם בתוכנית הזו. הסבירו איך החוויה הזו עשויה להשפיע על אופן העבודה שלכם בעונת Google Docs.