מערכות מנהליות – תיעוד העבודה (ספר פרויקט)

מערכות מנהליות – תיעוד העבודה (ספר פרויקט)

ספר פרויקט אמור להכיל את החלקים הבאים:

1.       שער הפרויקט

  • שם הפרויקט
  • שם המבצע
  • שם המנחה
  • שם בית הספר
  • תאריך ההגשה

2.       תוכן עניינים

3.       הקדמה (מבוא)

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

4.       מדריך למשתמש

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

  • הסבר כיצד להתקין את התכנית, אם קיים מערך התקנה
  • הסבר כיצד להריץ את התכנית (בעזרת איזו קובץ, קיצור דרך וכו`)
  • הסבר כיצד מפעילים את ממשק למשתמש (כדאי לעשות זאת בעזרת צילומי המסכים הרלוונטיים ומתן הסברים על פניהם)
  • רשימת כל הפעולות והאופציות שקיימות בתוכנה (עץ תפריטי, מפת הפעולות וכדומה)

5.       מדריך למפתח

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

  • ארגון קובצי התוכנה: תאור יעוד של כל קובץ
  • עץ מודולים: תאור תפקיד של כל מודול
  • עבור כל מודול:
    • תאור מבני נתונים
    • תיעוד עבור כל פעולה
  • תיאור האלגוריתמים של המודולים המרכזיים (תרשים זרימה או עברית מבנית)

6.       רקע תיאורטי (מדעי)

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

7.       סיכום אישי

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

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

8.       נספחים

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