רעיונות לפרויקטים

השלב הנוכחי:
התוכנית 'עונת התיעוד' של 2021 הסתיימה ב-14 בדצמבר 2021. ציר הזמן

הדף הזה מיועד לארגונים בקוד פתוח שנמצאים בשלב הבדיקה של תהליך הגשת הבקשה לארגון. רעיונות הפרויקטים האלה הם רק דוגמאות שממחישות איך ארגונים יכולים לתאר פרויקטים אפשריים של תיעוד בדף רעיונות הפרויקטים של הארגון. ארגונים יכולים להציע פרויקטים שלא נכללים ברשימה הזו.

רעיון לפרויקט: יצירת מדריך למשתמשים חדשים בתכונה

הבעיה

  • שותפים חדשים לא מצליחים למצוא את פרטי ההגדרה הנדרשים כדי לתרום באופן משמעותי לפרויקט שלנו. תהליכים מסוימים (כמו תרומה לבדיקות שלנו) לא מתועדים בכלל.

איך נמדוד את ההצלחה?

  • עלייה במספר התורמים החדשים
  • הגדלת מספר התורמים החדשים שלא כותבים קוד (על ידי הפיכת התהליך לקל יותר ליצירת מסמכים או בדיקות)
  • ירידה במספר הבעיות שתורמים חדשים העלו
  • עלייה במספר הבעיות הסגורות שתויגו בתג 'בעיה טובה לתחילת העבודה'

אילו כישורים נדרשים לכותבים טכניים כדי לעבוד על הפרויקט הזה?

  • חובה: היכרות עם GitHub (או נכונות לעבוד עם מדריכים של GitHub)
  • יתרון: היכרות עם הכלי שלנו להרצת בדיקות, כדי להריץ את הבדיקות ולעדכן את המסמכים לצורך כך

מתנדבים

כדאי לעודד חברי קהילה להירשם כדי לעזור במשימות מסוימות, למשל:

  • @JaneQDev, יכול לעזור לענות על שאלות לגבי הבדיקות שלנו
  • @ChenPCoder, happy to review docs pull requests
  • @ErichJEngineer, can walk through current contribution process with technical writer

פרטים ליצירת קשר

  • אם אתם כותבים טכניים שרוצים לעבוד על הפרויקט הזה, תוכלו לשלוח אימייל לכתובת email@project. יש לכלול קישורים לעבודות שלך בכתיבה טכנית או לפורטפוליו/ל-CV.

רעיון לפרויקט: כתיבת מדריכים לשימוש בספרייה שלנו עם ...

הבעיה

  • בפרויקט שלנו מתקבלות הרבה דיווחים על בעיות ממשתמשים שמנסים להשתמש בספרייה שלנו עם $TechnologyX. אין לנו מדריך ברור לשילוב עם $TechnologyX והוא עלול להיות מסובך!

איך נמדוד את ההצלחה?

  • ירידה במספר הבעיות שמסומנות בתג '$TechnologyX'
  • עלייה במספר בקשות המשיכה (pull requests) של שותפים חדשים שיעזרו לנו לתקן באגים או להוסיף למסמכי העזרה בנושא $TechnologyX
  • קישורים נוספים לפרויקט שלנו מפרויקטים של $TechnologyX

אילו כישורים נדרשים לכותב טכני כדי לעבוד על הפרויקט הזה?

  • יתרון: היכרות מסוימת עם $TechnologyX

מתנדבים

כדאי לעודד חברי קהילה להירשם כדי לעזור במשימות מסוימות, למשל:

  • @JaneQDev, יכול לעזור עם תשובות לשאלות על $TechnologyX
  • @ChenPCoder, happy to review docs pull requests

פרטים ליצירת קשר

  • אם אתם כותבים טכניים שרוצים לעבוד על הפרויקט הזה, תוכלו לשלוח אימייל לכתובת email@project. יש לכלול קישורים לעבודת הכתיבה הטכנית שלך או לתיק עבודות/קורות חיים/CV.

רעיון לפרויקט: ארגון מחדש של המסמכים שלנו

הבעיה

  • התיעוד שלנו נרחב ולא מאורגן. הרבה משתמשים מוותרים על הניסיון למצוא תשובות במסמכי העזרה, ובמקום זאת פשוט מדווחים על בעיות או שואלים שאלות בפורומים שלנו. הדפים שלנו לא מופיעים בתוצאות החיפוש גם עבור מילות מפתח רלוונטיות.

איך נמדוד את ההצלחה?

  • אופטימיזציה טובה יותר למנועי חיפוש במסמכי התיעוד שלנו
  • ירידה במספר הבעיות שדווחו בנושאים שמופיעים במסמכים
  • עלייה במספר התרומות לתיעוד

אילו כישורים נדרשים לכותב טכני כדי לעבוד על הפרויקט הזה?

  • יתרון: ניסיון בארגון מחדש של קבוצות גדולות ומפותחות של מסמכי תיעוד, הבנה של אופטימיזציה למנועי חיפוש (SEO)

מתנדבים

מומלץ לעודד את חברי הקהילה להירשם ולעזור במשימות ספציפיות, למשל:

  • @ChenPCoder, אשמח לבדוק את בקשות המשיכה של המסמכים

פרטים ליצירת קשר

  • כותבים טכניים שמעוניינים לעבוד על הפרויקט צריכים לשלוח אימייל לכתובת email@project. יש לכלול קישורים לעבודות שלך בתחום הכתיבה הטכנית או לפורטפוליו/ל-CV.

רעיון לפרויקט: הרצת תיקון בתיעוד

הבעיה

  • יש לנו הרבה באגים קטנים ובעיות ישנות שקשורות למסמכי התיעוד שלנו. הקהילה שלנו תשמח לעזור לנו לעשות סדר, אבל אנחנו צריכים שמישהו יארגן וינהל את התיקון בפועל.

איך נמדוד את ההצלחה?

  • מספר הבעיות שקשורות למסמכים שנסגרו
  • עלייה במספר התכנים שנוספו למסמכי העזרה ובמספר האנשים שתרמו תוכן

אילו כישורים נדרשים לכותב טכני כדי לעבוד על הפרויקט הזה?

  • יתרון: ניסיון בהרצת תיקון במסמכי התיעוד
  • מיומנויות ארגוניות מעולות

מתנדבים

מומלץ לעודד את חברי הקהילה להירשם ולעזור במשימות ספציפיות, למשל:

  • @ChenPCoder, יכול לעזור לארגן את הסרטון והצ'אט של ה-Fixit ולמצוא מתנדבים באזורי זמן אחרים

פרטים ליצירת קשר

  • אם אתם כותבים טכניים שרוצים לעבוד על הפרויקט הזה, אתם יכולים לשלוח אימייל לכתובת email@project, לפתוח פנייה או לשאול בפורום שלנו. חשוב לכלול קישורים לעבודות הכתיבה הטכנית או לתיק עבודות/résumé/CV.

רעיון לפרויקט: ביצוע ביקורת של מסמכי התיעוד

הבעיה

  • אין לנו מושג מה המצב של המסמכים שלנו. קשה לתת עדיפות לשיפורים במסמכים כי אין לנו תוכנית עבודה או מושג לגבי הבעיות הדחופות ביותר. יש לנו גם הרבה תוכן לא עדכני שצריך למחוק או להעביר לארכיון.

איך נמדוד את ההצלחה?

  • יצירת מפת דרכים ליצירת מסמכי עזרה עם אישור כללי מהקהילה
  • הפחתה במספר הדפים של מסמכי העזרה שאינם עדכניים או שגויים

אילו כישורים נדרשים לכותב טכני כדי לעבוד על הפרויקט הזה?

  • יתרון: ניסיון בביקורת מסמכים

מתנדבים

מומלץ לעודד את חברי הקהילה להירשם ולעזור במשימות ספציפיות, למשל:

  • @JaneQCoder יכול לעזור לתאם את הצגת מפת הדרכים של התיעוד בפגישה של הקהילה.

פרטים ליצירת קשר

  • כותבים טכניים שמעוניינים לעבוד על הפרויקט צריכים לשלוח אימייל לכתובת email@project/פתיחת בעיה או שאלות בפורום שלנו. יש לכלול קישורים לעבודות שלך בתחום כתיבת טקסטים טכניים או לפורטל/ל-CV.