בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- OpenELIS גלובלי
- כותבים טכניים:
- Areesha
- שם הפרויקט:
- מסמכי תיעוד של OpenELIS למשתמשי קצה
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
אנחנו שואפים לעצב מחדש ולשפר את התיעוד שמוצג למשתמשים עבור OpenELIS. I-TECH מתכוונת לחולל מהפכה באופן שבו משתמשי OpenELIS מקבלים עזרה על סמך הצרכים הספציפיים שלהם בהקשר. נכון לעכשיו, ההוראות לשימוש ב-OpenELIS נכללות במדריך משתמש אחד, והניווט בו יכול להיות משעמם ומתבזבזת בו זמן רב. משתמשים מסוימים, במיוחד משתמשים חדשים, מעריכים את הגישה למגוון רחב של חומרים שאפשר לעיין בהם וללמוד מהם תוך כדי תנועה. משתמשים אחרים, במיוחד משתמשים מנוסים יותר שמכירים מוצר דיגיטלי ספציפי כמו OpenELIS, ירצו לאתר משאב ספציפי במהירות ולהשתמש בו כדי להשלים את הכנסת הנתונים או את המשימה של הדיווח. הפעילויות הספציפיות כוללות:
המרת מדריך המשתמש הקיים (הלא מעודכן) לספרייה מקיפה ומעודכנת של עזרי עבודה ומדריכים כתובים על כל הפונקציונליות הנוכחית (כולל פונקציונליות חדשה יותר, כגון ניהול בדיקות, סריקת ברקוד, הזנת אצווה וייבוא תוצאות של כלי ניתוח), כולל תגי מטא-נתונים שעוזרים להוסיף את המידע לאינדקס;
פיתוח או עדכון של גרסה באנגלית של חומרי העזרה
מתן גישה למשתמשים לרשימה של '10 הפריטים המובילים' של כלי העזר הנפוצים ביותר.
יצירת מדריך סגנון ומסמך מוסכמות בתכנות