<Org Name>: <Year> Google Season of Docs Case Study
שם הארגון או הפרויקט:
קישור ל-Season of Docs:
תיאור הארגון: משפט אחד או שניים שמספקים סקירה כללית קצרה של הפעילות של הארגון או הפרויקט.
מחברים: רשימת המחברים של ניתוח המקרה. אם נדרש, יש להשתמש בשמות משתמשים (אופציונלי)
סיכום
ממלאים את הטבלה הבאה ומספקים תשובות קצרות לשאלות. תוכלו לספק פרטים נוספים בקטעים הבאים. מומלץ לכתוב קודם את החלקים המפורטים, ואז לחזור ולכתוב את הסיכום.
# Tech Writers | שעות עבודה בפרויקט TW | תקציב | % Project Completed |
---|---|---|---|
## | ## | $X | X% |
איזו בעיה ניסית לפתור? ואיך ניסית לפתור אותה?
מה היו התוצאות של הפרויקט?
מה עבד טוב? ומה היית עושה אחרת?
איזו עצה היית נותן לפרויקטים אחרים שמנסים לפתור בעיה דומה באמצעות תיעוד?
תיאור הפרויקט
ממלאים את הקטעים הבאים כדי לתאר את הפרויקט.
הצעת פרויקט
יש לספק סיכום קצר של ההצעה וקישור לדף ההצעה באתר הפרויקט.
תהליך יצירת ההצעה
איך הגעת להצעה שלך ל-Google Season of Docs? איזה תהליך נעשה בארגון כדי לקבל החלטה לגבי רעיון? איך ביקשת משוב ושלבת אותו בתוכנית? מי השתתף בתהליך? כמה זמן נמשך התהליך?
תקציב
עונים על השאלות בטבלה הבאה.
כמה כסף ביקשת? | |
איך הגעת לאומדן הזה? | |
כמה שעות עבודה הקצית לפרויקט? | |
כמה שעות עבודה נדרשו בפועל לפרויקט? | |
אילו הוצאות נוספות כללת בתקציב? | |
האם נתקלת בהפתעות תקציביות במהלך הפרויקט (למשל, הערכות שגויות)? אם כן, יש להסביר. |
גיוס כותבים טכניים
איך מצאת את הסופר הטכני שלך ושכרת אותו? האם התהליך עבד כמו שצריך? האם הם נשארו במשך כל הפרויקט?
משתתפים אחרים
מי עוד עבד על הפרויקט הזה (יש להשתמש בשמות משתמשים אם המשתתפים מבקשים זאת)? איך גייסתם אותם? אילו תפקידים היו להם? האם הם נשארו למשך כל הפרויקט?
ציר הזמן
מציגים סקירה כללית קצרה של ציר הזמן של הפרויקט (מציינים את תאריך הסיום המשוער או אבני דרך ביניים, אם הפרויקט נמשך). האם היה צורך לבצע שינויים בלוח הזמנים המקורי?
תוצרים
ממלאים את הטבלאות הבאות כדי לתאר מה נוצר, עודכן או השתנה במהלך הפרויקט. כדאי לכלול גם פריטים מתוכננים וגם פריטים לא מתוכננים. חשוב לכלול דברים שתכננתם אבל לא השלמתם.
פריטים נדרשים מתוכננים
קישורים רלוונטיים יכולים לכלול מסמכים שפורסמו, בקשות משיכה או ארטיפקטים אחרים.
התוכן שנשלח | % הושלם | קישורים רלוונטיים | הערות |
---|---|---|---|
פריט מס' 1 | |||
… | |||
מסמך מס' N |
פריטים לא מתוכננים להעלאה
האם נוצרו פריטים שלא תוכננו בתחילת הפרויקט? אם כן, יש להסביר.
מדדים
אילו מדדים בחרתם למדוד את הצלחת הפרויקט? הצלחת לאסוף את המדדים האלה? האם הבחנת בשינוי כלשהו כתוצאה מהפרויקט? האם הוספת או הסרתם מדדים מאז ההצעה? באיזו תדירות אתם מתכוונים לאסוף מדדים מעכשיו והלאה?
ניתוח
יש לספק תיאור קצר של התהליך שבו התנהל הפרויקט. האם הפרויקט היה מוצלח? למה או למה לא? או מתי תוכלו להעריך את ההצלחה? האם נתקלת באתגרים או בקשיים לא צפויים? האם הפרויקט הוביל לתהליכים או לנהלים חדשים או מעודכנים בארגון?
לקחים
אפשר להשתמש בטבלאות הבאות כדי להדגיש את הלקחים שלמדתם – מה הלך טוב ומה אפשר לשפר. אפשר להשתמש בקטגוריות הנושאים שמפורטות בהתאם לצורך, או להוסיף קטגוריות משלכם. אפשר להוסיף כמה שורות לנושא נתון לפי הצורך. הלקחים האלה יתווספו לרשימת השיטות המומלצות שלנו לפרויקטים של תיעוד.
מה עבד טוב?
כדי לשתף את הלקחים שלכם, תוכלו להוסיף לקובץ לקחים משלכם או להצביע על אחד משיטות העבודה המומלצות הקיימות של Google Season of Docs.
נושא | מה עשינו | לקח |
---|---|---|
תקציב | ||
תקשורת | ||
הדרכה | ||
מדדים | ||
הדרכה למשתמשים חדשים | ||
משתתפים | ||
פריטים נדרשים לפרויקט | ||
ניהול פרויקטים | ||
גיוס והעסקה | ||
… | ||
<Other Topics as Needed> | ||
מה אפשר לשפר?
כדי לשתף את הלקחים שלכם, תוכלו להוסיף לקובץ לקחים משלכם או להצביע על אחד משיטות העבודה המומלצות הקיימות של Google Season of Docs.
נושא | מה עשינו | מה היינו עושים אחרת | לקח |
---|---|---|---|
תקציב | |||
תקשורת | |||
הדרכה | |||
מדדים | |||
הדרכה למשתמשים חדשים | |||
משתתפים | |||
פריטים נדרשים לפרויקט | |||
ניהול פרויקטים | |||
גיוס והעסקה | |||
… | |||
<Other Topics as Needed> | |||
נספח
אם יש לכם חומרים אחרים שאתם רוצים לקשר אליהם (לדוגמה, אם יצרתם חוזה לעבודה עם הסופר הטכני שלכם ואתם רוצים לשתף אותו, או תבניות לפרויקט התיעוד שלכם או מקורות מידע אחרים בנושא תיעוד פתוח, תוכלו לרשום אותם כאן ולקשר אליהם). נספח הוא גם מקום טוב לרשום קישורים לכלים או למשאבים של מסמכי העזרה שבהם השתמשתם, או לצרף תודות או הכרות טובה שלא מתאימות לקטעים הקודמים.