בקצרה: אפיון באנגלית לצוות בחו"ל צריך לכלול שלושה דברים שמסמך פנימי יכול לוותר עליהם: מילון מונחים שקובע תרגום אחד לכל מונח עסקי, קריטריוני קבלה שאפשר לבדוק בלי לשאול, וסעיף ישראלי שמפרט את מה שצוות זר לא יודע: תעודת זהות עם ספרת ביקורת, מע"מ ומספר הקצאה, שבוע עבודה מראשון עד חמישי, עברית מימין לשמאל בתוך ממשק באנגלית, ותיקון 13 לחוק הגנת הפרטיות. בלי הסעיף הזה הצוות יבנה מערכת נכונה למדינה אחרת.
למה תרגום לא מספיק
מסמך אפיון שנכתב בעברית לצוות ישראלי נשען על הקשר משותף. כשכתוב "חשבונית", כולם יודעים שמדובר בחשבונית מס עם מע"מ, ושמעל סכום מסוים צריך מספר הקצאה. כשכתוב "שבוע", כולם יודעים שהוא מתחיל ביום ראשון. צוות בחו"ל לא יודע את זה, והוא גם לא ישאל, כי הוא לא יודע שיש בכלל מה לשאול.
הכלל: כל מה שבצוות ישראלי היה ברור בלי להגיד, צריך להיות כתוב באפיון לצוות בחו"ל.
המבנה
המבנה המקובל של מסמכי דרישות באנגלית נשען על IEEE 830 ועל ISO/IEC/IEEE 29148, וצוותים בחו"ל מכירים אותו:
| סעיף | באנגלית | מה כותבים |
|---|
| מבוא | Introduction: Purpose, Scope, Definitions | מטרה, היקף, מה לא נכלל, ומילון המונחים |
| תיאור כללי | Overall Description | המוצר, המשתמשים, האילוצים וההנחות |
| דרישות | Specific Requirements | סיפורי משתמש עם קריטריוני קבלה, מודל נתונים ואינטגרציות |
| אימות | Verification | איך בודקים כל דרישה ומי מאשר |
| נספחים | Appendixes | מסכים, דוגמאות קבצים, הסעיף הישראלי |
מילון מונחים: תרגום אחד לכל מונח
הטעות הנפוצה היא לתרגם את אותו מונח עברי בכמה דרכים לאורך המסמך. "לקוח" הופך פעם ל-customer, פעם ל-client ופעם ל-account, והצוות בונה שלוש ישויות שונות. מילון המונחים קובע תרגום אחד, וכל המסמך משתמש רק בו.
| עברית | באנגלית במסמך | הערה |
|---|
| עוסק מורשה | Licensed VAT dealer (osek murshe) | להשאיר גם את המונח בעברית, כי הוא יופיע בממשק ובמסמכים |
| מספר הקצאה | Invoice allocation number | מספר שרשות המסים מנפיקה לחשבונית |
| חשבונית מס | Tax invoice | לא סתם invoice |
| תעודת זהות | Israeli ID number (teudat zehut) | תשע ספרות, כולל ספרת ביקורת |
הסעיף הישראלי
זה הסעיף שצוות בחו"ל הכי צריך ושהכי חסר. מה כדאי לכלול בו:
- תעודת זהות: תשע ספרות, עם אפסים מובילים משמאל וספרת ביקורת לפי אלגוריתם Luhn. בדיקה לא נכונה תפסול לקוחות אמיתיים.
- מע"מ וחשבוניות: חשבונית מס, מספר הקצאה לחשבוניות שמעל הסף, ושיעור המע"מ כפרמטר, לא כמספר קשיח בקוד.
- שבוע עבודה: מראשון עד חמישי, שישי הוא יום קצר, שבת היא יום מנוחה. חגים מתחילים בערב.
- עברית בממשק: כיוון מימין לשמאל, שדות שמשלבים עברית ואנגלית, ומספרים בתוך טקסט בעברית. בשדות קלט כדאי להנחות את הצוות להגדיר כיוון אוטומטי.
- פרטיות: תיקון 13 לחוק הגנת הפרטיות, ובמיוחד מה נחשב מידע בעל רגישות מיוחדת ומי רשאי לגשת אליו.
- מטבע ופורמטים: שקל, פורמט תאריך של יום לפני חודש, כתובות ומיקוד בן שבע ספרות.
קריטריוני קבלה שלא צריך לשאול עליהם
לכל דרישה כותבים קריטריון קבלה בצורה Given, When, Then: בהינתן מצב, כאשר מתרחשת פעולה, אז מתקבלת תוצאה. הצורה הזו מוכרת לצוותי פיתוח ובדיקות בכל העולם, והיא מונעת את השאלה "מה בדיוק התכוונתם", שבצוות בחו"ל עולה רק אחרי שהקוד כבר נכתב.
את קריטריוני הקבלה של הסעיף הישראלי כדאי לכתוב עם נתוני בדיקה אמיתיים: מספר תעודת זהות תקין ולא תקין, שם בעברית עם מילה באנגלית בתוכו, ותאריך שנופל על שבת.
שאלות נפוצות
איך כותבים מסמך אפיון באנגלית?
לפי המבנה המקובל של מסמכי דרישות: מבוא והיקף עם מילון מונחים, תיאור כללי, דרישות מפורטות עם קריטריוני קבלה, ואימות. לצוות בחו"ל מוסיפים סעיף שמפרט את מה שייחודי לישראל.
מספיק לתרגם את מסמך האפיון העברי?
לא. תרגום מעביר את המילים, אבל לא את מה שצוות ישראלי יודע בלי שאמרו לו: מע"מ ומספר הקצאה, שבוע עבודה, תעודת זהות, עברית מימין לשמאל ופרטיות. את כל אלה צריך לכתוב במפורש.
מה זה מילון מונחים ולמה הוא חשוב?
רשימה שקובעת תרגום אחד לכל מונח עסקי. בלעדיה אותו מונח מתורגם בכמה דרכים, והצוות בונה כמה ישויות במקום ישות אחת.
מה צוות פיתוח בחו"ל לא יודע על ישראל?
שתעודת זהות כוללת ספרת ביקורת, שחשבונית מעל סף מסוים צריכה מספר הקצאה, ששבוע העבודה מתחיל ביום ראשון, שהממשק צריך לתמוך בעברית מימין לשמאל, ומה דורש תיקון 13 לחוק הגנת הפרטיות.
באיזו צורה כדאי לכתוב קריטריוני קבלה?
בפורמט Given, When, Then, שמוכר לצוותים בכל העולם, ועם נתוני בדיקה אמיתיים לכל מה שייחודי לישראל.
מאיפה להתחיל
רשמו את עשרת המונחים העסקיים החשובים ביותר במערכת שלכם, וליד כל אחד את התרגום שהצוות בחו"ל משתמש בו היום. אם לאותו מונח יש יותר מתרגום אחד, מצאתם את הבעיה הראשונה.
דברו איתי
קשור: מסמך אפיון לדוגמה, תהליך אפיון מערכות, פיתוח מערכות ווב