איך ללמוד לכתוב מסמכי STD/STP?

[seeker1]

איך ללמוד לכתוב מסמכי STD/STP?

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

 

[seeker1]

כמה זמן אמורה לקחת כתיבת מסמכים אלה

 

[JohnDoe5]

אני למדתי שהשיטה הכי טובה

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

 

[vinney]

קצת בעיה

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

 

[seeker1]

תפקידי כאיש QA

בתפקידי כאיש QA (יחיד) בחברת סטרט אפ קטנה הייתי אחראי על תכנון הבדיקות כראות עיני באפליקציה ודיווח למחלקת פיתוח ע"י כתיבת מסמכים בוורד. היום, כשאני מחפש משרה בתחום, נדרש ממני ידע וניסיון בכתיבת STD/STP. לכן אני מנסה ללמוד מתוך תבניות המסמכים שמפורסמים כאן, אבל זה מאוד קשה לי ללא מסמכים אמיתיים. ברור לי שמפאת סודיות לא ניתן לפרסם מסמכים אמיתיים, אבל חשבתי שאולי מישהו יכול לפברק מיסמך שיכול היה להיות שמיש במציאות.

 

[אבי ע]

אולי אוכל לעזור ... ../images/Emo39.gif

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

 

[vinney]

שוב אתה עם הQC...

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

 

[אבי ע]

לא לא, אתה פשוט נעול... ../images/Emo39.gif

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

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

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

 

[vinney]

../images/Emo9.gif

 

[אבי ע]

בקשתך מולאה ../images/Emo8.gif

 

[minidror]

איפה ניתן לראות את המסמכים שכתבת?|ת

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

 

[אבי ע]

הבקשה שמולאה איננה... ../images/Emo39.gif

העברת המסמכים אלא הבקשה לתקן אותו אם הוא טועה

אם אוכל, אשתדל לשים אותם כאן בשבוע הבא.

 

[minidror]

אה...../images/Emo51.gif

 

[seeker1]

תודה, זה יעזור לי ולשכמוני מאוד

האם מדובר במסמכי STD או STP ?

 

[ScrollLock]

כמה "כללי אצבע" פשוטים

1. קודם כל חשוב להגדיר בדיוק את המטרות והקריטריונים להצלחה/כישלון של כל בדיקה. 2. חשוב להגדיר בדיוק (!) מה המשאבים שדרושים לביצוע של כל בדיקה כדי למנוע "היתקעויות" מיותרות בהמשך. 3. כל בדיקה צריכה צריכה להיות מתוארת כך שלא יהיה מקום לכפל משמעויות או טעויות/סטיות במהלך הביצוע ומצד שני - לא צריך לזבל יותר מדי ת'שכל...