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