בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- moja global
- כותבים טכניים:
- Anthony
- שם הפרויקט:
- תיעוד של הקוד של כלי הדיווח
- אורך הפרויקט:
- אורך רגיל (3 חודשים)
תיאור הפרויקט
בהתאם להזדמנות לתעד את כלי הדיווח של ארגון Moja Global, אני מציע לפתח 6 סוגים של מסמכים תיעודיים שיעזרו לקהלים שונים להשיג מטרות שונות. הם מסוכמים בהמשך:
1)מדריך להגדרת הסביבה
1.1) קהל היעד: מהנדסי מערכות
1.2) מטרה: לעזור למהנדסי מערכות להגדיר סביבה מקומית לפיתוח ולביצוע של כלי הדיווח.
1.3) פורמט של מאמר הדרכה שמפרט את סדר השלבים שמהנדסי המערכת צריכים לבצע כדי להגדיר את הסביבה שתאפשר את היצירה וההפעלה של כלי הדיווח.
2) מדריך build
2.1) קהל היעד: מהנדסי מערכות
2.2) מטרה: לעזור למהנדסי מערכות ליצור את הרכיבים של כלי הדיווח מקוד המקור
2.3) פורמט של מאמר הדרכה שמפרט את קבוצת השלבים הסדורים שמהנדסי המערכת צריכים לבצע כדי לקבל ולעבד את קוד המקור של כלי הדיווח.
3) מדריך ההתקנה
3.1) מהנדסי מערכת של קהל היעד
3.2) מטרה: לעזור למהנדסי מערכות להתקין רכיבים חדשים של כלי הדוחות
3.3) פורמט של מאמר הדרכה שמפרט את רצף השלבים שמהנדסי המערכת צריכים לבצע כדי לפרוס את כלי הדיווח בסביבה חדשה שהוגדרה.
4) מדריך הפעלה
4.1) מטמיעי מערכת של קהל היעד
4.2) מטרה: לעזור למהנדסי מערכת להריץ מכונה חדשה של כלי הדיווח
4.3) פורמט של מאמר הדרכה שמפרט את רצף השלבים שעל מפתחי המערכות לבצע כדי להעלות ולעבד מסדי נתונים של פלט Flux במכונה שפועלת של כלי הדיווח.
מדריך לפעולה הצטרפות למסדי נתונים של פלט Flux ועיבוד שלהם בכלי הדיווח
5)מדריך למשתמש
5.1) משתמשי קצה של קהל היעד
5.2) מטרה: לעזור למשתמשי הקצה להבין את התכונות השונות שמוטמעות בכלי הדיווח ואת האופן שבו צריך להשתמש בהן.
5.3) פורמט מאמר הדרכה המתאר את סדרת השלבים הרציפים שמשתמשי הקצה חייבים לבצע כדי להשתמש כראוי בפונקציונליות של כלי הדיווח.
6) מדריך פיתוח
6.1) מתכנתים של קהלי היעד
6.2) מטרה לעזור למשתמשי הקצה להבין את התכונות השונות שמוטמעות בכלי הדיווח ואיך צריך להשתמש בהן.
6.3) פורמט של מאמרים מפורטים שמתארים: א) רכיבי העיצוב העיקריים שמרכיבים את הכלי ב) הפירוק הפונקציונלי של הרכיבים שלמעלה ג) רכיבי הביצוע של הרכיבים שפוצלו באופן פונקציונלי ד) ארגון קוד המקור או הספריות של הכלי ה) החזון לטווח הארוך והכיוון לשיפור מתמשך ו) תחומי השיפור הבאים באופן לוגי
וכן מדריך קצר שמסביר איך אפשר להתאים את הקוד לנסיבות ספציפיות של משתמשים