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

השלב הנוכחי:
סיום הפרויקט. ציר הזמן

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

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

הבעיה

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

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

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

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

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

מתנדבים

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

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

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

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

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

הבעיה

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

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

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

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

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

מתנדבים

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

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

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

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

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

הבעיה

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

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

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

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

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

מתנדבים

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

  • @ChenPCoder, happy to review docs pull requests

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

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

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

הבעיה

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

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

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

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

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

מתנדבים

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

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

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

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

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

הבעיה

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

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

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

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

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

מתנדבים

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

  • @JaneQCoder, can help coordinate presenting the documentation roadmap in our community meeting

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

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