תיעוד תוכנה

[BMWE]

../images/Emo53.gifתיעוד תוכנה

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

 

[voguemaster]

תאר לנו מה אתה רוצה לתעד

כדי שנדע על מה אתה מדבר. יש מלאן סוגים של תיעוד

 

[BMWE]

יש לי תוכנה לפרוייקט הנדסי

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

 

[voguemaster]

איזה סטנדרטים ?? ../images/Emo2.gif

 

[אוֹריארד]

איזה שפה, איזה תיעוד, איזה סטנדרטים

יש כמה רבדים של תיעוד פרוייקט: אם אתה מדבר על רמת הקוד - חפש באינטרנט Coding Standards - זה ייתן לך "יישור קו" לגבי איך הקוד נראה (ותלוי מאוד על איזה שפות אתה מדבר מן-הסתם). אם אתה מדבר על תיעוד של הקוד - אז בשפות כמו Java למשל יש סטנדרט מובנה (Javadoc). אם אתה מדבר על תיעוד כחלק מהנדסת המערכת - אז יש נהלים שנותנים לך הנחיות לאיזה תיעוד צריך להיות. החל מנהלים יותר "קשוחים" שממש מפרטים איזה מסמכים צרכים להיות ומה צריך להיות כתוב בהם (כמו DOD-STD-2167A או כמו MIL-STD-498), ועד לנהלים שנותנים הנחיות כלליות לגבי התיעוד ומתמקדים יותר בתהליך העבודה (כמו ISO-9000). יש גם תקן אירופאי נפוץ שנקרא PSS-05 של סוכנות החלל האירופאית. אם אתה רוצה לנהוג בפטריוטיות - יש גם נוהל ישראלי: נוהל מפת"ח. אם בא לך עברית - אז יש להם גם templates טובים.