סוגי תיעוד תוכנה

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

הצעה

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

בדיקת היתכנות

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

ניתוח דרישות

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

מסמכי עיצוב

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

מסמכי קידוד

קידוד מסמכים מתייחסים קוד המקור בפועל המשמש תכנות של התוכנה. הקוד יכול להיות כתוב בכל מספר של שפות מחשב זמינות, כולל Java, C + +, PHP ומאות שפות מחשב אחרות בהתאם למערכת שבה נעשה שימוש.

מסמכי בדיקה

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

מדריכים למשתמש ושיווק

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

רשיונות תוכנה

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