כללי
- המדריך מתאים לכתיבת ערך חדש ו/או (בשינויים המתבקשים) לתיקון של ערך קיים.
- המדריך לא מחליף הנחיות טכניות ואחרות הקשורות לכתיבה ועריכה אלא נוגע רק בנושא של פישוט והנגשה.
- עבודת פישוט תיעשה באתר במרחב "פישוט".
- המדריך נועד בעיקר לפישוט והנגשה של האתר בעברית. בערבית ורוסית, הערכים מלכתחילה מפושטים יותר מאשר הערכים בעברית שכן עברו תרגום, עריכה ובקרה משפטית. עם זאת, עורכי התוכן בעברית וברוסית צריכים להכיר את המדריך ואת ההנחיות והכלים המוצגים בו כי חלקם מחייבים / מסייעים לעבודת העורכים גם של האתרים בשפות השונות.
- כששולחים ערך לפידבק צריך לזכור שהוא עובר לפורמט וורד לצורך הפידבק - לכן:
- לא לעשות תיקונים בערך עצמו באתר עד שמשחררים את הפישוט, או
- לעדכן על השינוי כדי שנוציא וורד חדש (רק במקרי קיצון).
- כשמעבירים ערך לוורד להערות:
- יש לפתוח את תוכן העניינים, את השאלות, את הדוגמאות וכו' - כל מה שמקופל צריך להיות פתוח לפני ההעתקה לוורד.
- לצורך כתיבת / עריכת ערך:
- יש להכיר את הנושא היטב,
- להבין עבור מי הערך נכתב,
- לשים את החוק בצד - החקיקה היא רק אסמכתא ולא טקסט אותו משכתבים,
- ליצור מבנה נכון.
עקרונות כלליים (ראו פירוט בהמשך)
- הקפדה על אחידות בטרמינולוגיה לאורך כל הערך.
- שיוך תוכן ספציפי לפסקה רלוונטית (מה ששייך למימוש - במימוש וכו').
- כתיבה יומיומית בגובה העיניים - לדמיין שיחה. לא כתיבה משפטית או שכתוב של החוק או התקנה.
- צמצום חזרתיות.
- משפטים קצרים, פסקאות קצרות.
- צמצום שימוש בסוגריים.
- הפחתת לינקים.
- אין להתחיל משפט ב:
- "על פי החוק ____"
- "על פי הפסיקה ____"
- "אם" (למעט במקרים של תתי בולטים להצגת אפשרויות שונות).
- לשון זכר/נקבה
- טרם התקבלה החלטה סופית בארגון.
- יש אופציות כמו "מי שעומדים בתנאים הבאים יהיו זכאים" או "מי שעומד בתנאים הבאים יהיה זכאי".
- כעקרון כל משפט בטקסט צריך לעמוד בפני עצמו:
- אסור להניח שהקורא קרא את הכותרת או את המשפט שלפניו.
- רוב האנשים סורקים טקסטים בעיניים.
טרמינולוגיה באתר:
- קוראים לכל עמוד "דף" – לא "ערך" ולא "עמוד".
אזהרות משפטיות:
- הקפדה שפישוט לא ייצור סיכון משפטי.
- דוגמה: עובד שעוזב את מקום עבודתו - לא לומר "פשוט עזב", אלא "סיים את יחסי העבודה".
כתיבה בנושאים עם שינוי זמני:
- שינוי זמני (כגון בתשלומים בתקופת חירום) - לציין בשים לב או דגשים בהתאם.
כתיבה יומיומית ודוגמאות :
- מותר לכתוב "לדוגמה" בטקסט.
- עדיף כתיבה רגילה מאשר להכניס כל דוגמה לתוך תיבה מעוצבת אם אינה נדרשת.
כתיבה מגדרית באתר:
- אין להשתמש בלוכסנים (למשל: "עובד/ת").
- במקום זאת: "עובד או עובדת", "בן או בת זוג" לפי הצורך.
הפניות למחשבון או מקורות ממשלתיים:
- אם יש מחשבון רלוונטי, הפניה תהיה בדגש ממשל ובפסקת חישוב הזכאות.
- להפנות לקישור קונקרטי ולא לאתר כללי.
חישובים ודוגמאות בחישוב :
- להוסיף דוגמאות.
- לבדוק בעצמנו את החישוב כדי לוודא שהמלל ברור.
רקע בערכים :
- חובה להוסיף פסקת רקע קצרה אם משתמשים במונחים מקצועיים מורכבים.
בדיקות לפני שחרור ערך מפושט :
- לבדוק שינויים בערך המקורי.
- לבדוק מבנה תוכן עניינים.
- לבדוק קריאה תקינה בנייד (inspect במחשב).
ראו גם: מדריך לשחרור ערכים מפושטים
איך לבנות ערך?
- תבנית עריכה יכולה להיות:
- מבנה כרונולוגי
- הוק (Hook)
- מבוא–מידע–סיכום
- תרשים זרימה (עץ החלטות)
- שילובים של הנ"ל
- תכנון מוקדם יתבצע לפי המטרות, קהלי היעד ומסעות הלקוח.
- מיפוי תוכן ונושאים:
- מתחילים ברשימה של כל הנושאים ותתי-הנושאים ברמת הכותרת – ללא סדר או היררכיה.
- שלב זה מאפשר לשקול אם לפצל את הערך או לאחד עם ערך אחר.
- מונע כפילויות וחזרתיות – לכל נושא יש מקום אחד.
- קיבוץ והיררכיה:
- ארגון הכותרות לקבוצות לפי נושאים ותתי-נושאים.
- כתיבה:
- לפרק את הטקסט עוד ועוד.
- ליצור כותרות וכותרות ביניים.
- להשתמש בבולטים.
- להקפיד שכל בולט עומד בפני עצמו.
- הוספת אקסטרות:
- שימו לב
- טיפ
- אזהרה
- דוגמה
לפני שנתחיל לכתוב / לערוך
הבנת הנושא, למי מיועד הטקסט, מסע לקוח, פרסונות
- הבנת והכרת הנושא באופן מיטבי.
- למי אני כותבת את הערך, מה מסע הלקוח שלו, באיזה שלב הוא נכנס לאתר. סוגי פרסונות ומסעות לקוח.
- מי קהל היעד העיקרי שהערך רלוונטי עבורו
- לדוגמא - הערך בקשה למימוש משכנתא או משכון על דירת מגורים בהוצאה לפועל – נכתב עבור הבנק או עבור ה"חייב"? מי יהיו רוב הקוראים של הדף הזה? כנראה החייבים ולכן הכתיבה צריכה לפנות אליהם ולא אל הבנק.
סוגיות נוספות שעולות מהדוגמא: האם כולם יודעים מה זה "מימוש משכנתא"? אולי צריך מילת הסבר? חשוב להציף מידע רלוונטי לחייב כבר בהתחלה – ולכן כבר בדגשים כדאי להפנות ל מדריך לנוטלי משכנתא על דירת מגורים שנפתח נגדם תיק הוצאה לפועל
מה ייצא לקורא/ת
- מה התועלת של הקורא מקריאת הערך?
- אם מדובר בזכות עם ערך כספי – להציג את הסכומים בתחילת הערך.
- אם מדובר בזכות למניעת פיטורין – להסביר מייד מה מותר ומה אסור.
מה חשוב לרוב הגולשים ומה הם מקרי הקצה
- לזהות מהם המקרים הנפוצים ולתת להם מענה ברור.
- את מקרי הקצה – ניתן להעביר לשאלות ותשובות.
מה כבר קיים בנושא / ערכים קשורים
- מיפוי של ערכים קיימים באתר.
- האם יש דפי זכות והליך נפרדים? מדריכים?
- האם יש כפילויות?
- האם כדאי לאחד או לפצל ערך?
- כל שינוי במבנה מחייב אישור של העורך הראשי.
מיפוי וקיבוץ
- מיפוי כל חלקי הערך הקיים.
- תיוג של כל פסקה – איפה היא צריכה להופיע בערך המפושט.
- שימוש במיפוי גם ככלי לבדיקה לאחר העריכה.
- לוודא זרימה רציפה של מסע הלקוח.
- להימנע מקפיצות בין נושאים או כפילויות.
עקרונות פישוט והנגשה בכתיבה או עריכה של ערך
מבנה הערך וראשי פרקים
- להגדיר מה הכי חשוב לרוב הקוראים.
- לקבוע סדר נכון לנושאים.
- להחליט מהם ראשי הפרקים.
- להבטיח שתוכן העניינים ייצג את מבנה הערך בצורה מדויקת.
כתיבת הערך נעשית מלמטה למעלה
- מתחילים בקביעת ראשי הפרקים.
- כותבים תוכן תחת כל ראש פרק.
- מוודאים שאין כפילויות בין פרקים.
- כותבים את פסקת הפתיחה ("בקצרה") רק אחרי שכל התוכן מוכן.
- כותבים דגשים אחרי סיום הערך.
דגשים, פסקת פתיחה
רקע
- בפרק זה נתייחס באופן שונה לדגשים ולפסקת הפתיחה(אשר נקראת "בקצרה") בדפי זכות ודפי הליך עצמאיים לעומת בדפי הליך שאינם עצמאיים.
- דפי הליך "עצמאיים" הינם דפי הליך בהם עצם ההליך הוא הוא הזכות. דפים אלו אינם מהווים הליך של מימוש זכות הכתובה בדף זכות אלא עומדים בזכות עצמם, (למשל הגשת תלונה למבקר המדינה) ולכן ההתייחסות אליהם בפרק זה היא כאל דפי זכות.
- דפי הליך שאינם עצמאיים הינם דפי הליך אשר נגזרים מדף זכות - כלומר הליכים שהיו אמורים להיות בדף הזכות תחת הכותרת "הליך מימוש הזכות" אבל החלטנו (בדרך כלל בגלל אורכם, או הרלוונטיות שלהם למספר זכויות) יצור עבורם דף נפרד (לדוגמא - הליך קבלת סיוע בשכר דירה)
דגשים ותקציר בדפי זכות ובדפי הליך "עצמאיים"
דגשים
- מטרת הדגשים (בשונה ממה שהיה בעבר) היא לתת לקורא מעין "מפת התמצאות" - שהקורא יבין בדיוק היכן הוא נמצא, והאם הוא נמצא במקום הנכון. על מה הערך (בגדול), מה הוא יכול לקבל מהערך ומה לא והאם נכון לו לקרוא את הערך או לעבור לערך אחר שיותר נכון עבורו.
- הדגשים הם גם סוג של "טיזר" - לא סיכום ולא תקציר הערך. הדגשים יכללו הסבר קצרצר על מהות הזכות/ההליך כדי שהקורא יבין איפה נמצא
- בדגשים יש מעיין הנחיות איך לקרוא את הערך וסייגים שיוציאו את הקורא לערך אחר - . לדוגמא - ערך זה עוסק במידע על זכויות במקרים של איחור או עיכוב בטיסות. לזכויות במקרה של ביטול טיסה לחץ כאן>> , או הערך מתייחס ל קרן השתלמות לשכירים, אם אתה עצמאי כנס ל כאן XX).
- בדגשים תהיה גם הדגשה של אוכלוסיות שאולי לא מאמינות שהן זכאיות לזכות = לדוגמא - בדגשים על מענק עבודה נכתוב - "כולל עובדים עצמאים ועוזרות בית"
- הדגשים יכללו פואנטה פרקטית - כלומר, יציגו לקורא מה יוצא לו מזה - לדוגמא אם כתוב " זה יכול להיחשב עבירה מנהלית" הקורא לא מבין מה יוצא לו מזה אבל אם נכתוב במקום זה "במקרה זה ניתן להטיל עליו קנס" - הלקוח יבין מה יוצא לו מזה / וכי הערך יכלול מידע על מה כדאי או לא כדאי לעשות.
- התועלת עבור הקורא תופיע גבוה בתיבת הדגשים. צריך לוודא שהתועלת ברורה לדוגמא - כאשר יש לזכות "שווי" הדגש יתן את הערכת השווי (שווי ולא דרך חישוב). לדוגמא - בדמי הבראה לא ייכתב בדגש 480 ש"ח ליום הבראה אלא "שווי של אלפי שקלים בשנה"
- נשתמש בביטויים כמו "שעונים על התנאים המפורטים בהמשך" / "עשויים להיות זכאים"
- בדרך כלל לא תהיה הפניה לשאלות ותשובות (אלא אם החלטנו שיהיה ערך מוסף בהפניה כזו כבר בהתחלה - בדרך כלל לא)
- לשון פשוטה, משפטים קצרים, כמה שפחות צורך בסימני פיסוק
- מצב שיש משפטים שחוזרים על עצמם בדגשים ובתקציר אינו רצוי. הדגשים אינם תמצית הערך הם בעצם - בוא נוודא שאתה במקום הנכון
- דגש ממשל ישאר - ככל שההפנייה יותר קונקרטית לערך זה עדיף - ראו לדוגמא בערך - נקודות זיכוי ממס הכנסה ניתן להיעזר בסימולטור לחישוב נקודות הזיכוי (בגין מצב משפחתי) ובסימולטור לחישוב המס שינוכה על פיהן באתר רשות המסים
פסקת פתיחה
- לאחרונה הוספנו לפסקת הפתיחה את הכותרת "בקצרה" (בדפי הזכות ובדפי הליך - בכל השפות).
- בפסקת הפתיחה נכתוב כמה שורות המסבירות את ההליך / הזכות. מי שקורא את פסקת הפתיחה יקבל מושג כללי על עיקרי הדברים - מבלי להיכנס למקרי קצה ובין היתר יבין האם הדף ממש לא רלוונטי עבורו.
- חשוב - בפסקת ה "בקצרה" לא יופיע מידע אשר לא מופיע בהמשך הערך.
- פסקת הבקצרה לא תכיל מידע שלא מופיע במקום אחר בערך. טיפ הוא בדרכ לא חלק מהתקציר. התקציר יכלול תיאור של עיקרי הזכות + השבת תשומת הלב לדקויות אך בלי להכנס אליהן. לדוגמא - קיימים הבדלים בין שכיר לעצמאי / בין תושבים באזורים שונים ןכן' - - משהו שיעזור לקוראבקריאת הפסקאות הבאות, שיבין למה הן נוצרו. לדוגמא - גובה הפטור יינתן עד התקרה המפורטת בהמשך (אולי לינק אם זה ערך ארוך)
דוגמאות לדגשים ולפסקת פתיחה דפי זכות והליכים עצמאיים (לפני ואחרי פישוט)
דגשים ופסקת פתיחה בדפי הליך "לא עצמאיים"
- הסבר קצר על הרקע (מה הזכות הרלבנטית להליך, למי מתאימה וכו' - בכלליות) + לינק לדף הזכות הרלוונטי.
- משפט על כך שהדף מסביר את ההליך (לדוגמא - מסביר איך מערערים / מסביר איך מגישים תביעה וכד)
- אם נכון להפנות למקום מסוים / להוציא אנשים לא רלבנטיים מהדף
- לא כותבים בדגשים שום דבר שהוא לגופו של עניין אבל כן ננסה לכוון את הקורא במקרה שיש בערך אבחנות שחשוב שידע כבר בהתחלה. לדוגמא בערכים על ערעורים בהחלטות הוצל"פ - נכון לציין כי "קיימים הבדלים בין ערעור בנושא משפחה לערעור בנושא אחר". בנושאים של זכויות הקשורות לעבודה - "קיימים הבדלים בין עובד שכיר ועצמאי" ועוד.
דוגמאות לדגשים ופסקת פתיחה - בדפי הליך לא עצמאיים (לפני ואחרי פישוט)
תוכן עניינים
- לוודא שכל המידע בערך הוא תחת כותרות (כולל פסקת הפתיחה שכבר קבלה כותרת "בקצרה") כדי שהמידע יוצג בתוכן העניינים.
- לוודא שתוכן העניינים המוצג למשתמש נכון מבחינת המבנה והמשמעות (לעיתים נכון יהיה לעשות שינוי בכותרת כדי שתהיה מובנת בתוכן העניינים)
- לדוגמא – בערך זכויות בגין נכות רפואית ללא התניה בקצבת נכות אין כותרת לטבלה למרות שהיא מהות הערך. לכן הטבלה גם לא מופיעה בתוכן העניינים. אם נוסיף לטבלה כותרת (מדרגה 2) כמו "==טבלת זכויות לפי אחוזי נכות==" אז היא תופיע כחלק מתוכן העניינים.
כותרות
שם הערך
- ניתן לשנות את הכותרות במהלך עבודת הפישוט (לדוגמא - השינוי שהציע נואל בערך "פדיון חופשה שנתית" שבמקומו "תשלום עבור ימי חופש שלא נוצלו (פדיון חופשה שנתית)"
כותרות בתוך הערך
- חשיבות הכותרות - חייבים מהכותרת להבין על מה הפסקה תדבר ואיך היא קשורה לזרימה של הערך.
- הכותרת צריכה להתאים לנושא בכללותו - לדוגמא בזכאות המחושבת כמכפלה של שני פרמטרים הכותרת תהיה "חישוב הזכאות". אחרי הכותרת תופיע שורת הסבר כללית לדוגמא - דמי ההבראה מחושבים לפי מספר ימי ההבראה המגיעים לעובד כפול שווי של יום הבראה. ואחרי משפט זה תופענה שתי כותרות משנה - האחת - שווי יום הבראה, השנייה - כמה ימי הבראה מגיעים לעובד.
- כותרות קצרות.
- כותרות בלי סוגריים (אלא במקרה שחשוב לציין את המושג המשפטי).
- הכותרות תתארנה את הסיטואציה ולא את המינוח המשפטי
- לדוגמא - במקום "חלף הודעה מוקדמת" נכתוב "תשלום במקרה שלא עובדים בתקופת ההודעה המוקדמת" (ואם צריך - את ההגדרה המשפטית בסוגריים)
- משתמשים בכותרות הגנריות של הדף. כלומר, לא משנים את שמן, משבצים את המידע בהתאם לכותרות (אפשר כמובן ליצור תת כותרות) ורק אם יש מידע חשוב שלא מתאים לאף כותרת או תת כותרת, ניתן לייצר כותרת חדשה.
- לבדוק תמיד איך מופיעות הכותרות בתוכן העניינים
כותרת "מי זכאי" / "למי זה רלוונטי?"
- מפרטים את תנאי הזכאות בצורה ברורה.
- אם מורכב, משתמשים בבולטים או בהפניות.
כתיבה עם בולטים
- פסקאות ראשיות יתחילו עם בולט.
- נשתמש בבולטים רק כאשר יש יותר מפריט אחד בהיררכיה.
שימוש בבולטים ומספור לצורך פירוט ורשימות
- תנאים מצטברים - רשימות ממוספרות.
- תנאים חלופיים - תתי-בולטים.
- שלבים במימוש זכויות - מספור ברור.
התחלות משפט מודגשות שמשמות מעין כותרת
- אפשר להתחיל משפטים בהדגשה לחיזוק מיקוד התוכן.
מילים "אסורות"
- להימנע ממונחים מיותרים שמסרבלים את הקריאה.
- להיעזר ברשימת מילים אסורות ועדכונים.
הפניות ולינקים
- להפחית כמות לינקים.
- לא להכניס לינקים בדגשים או פסקת פתיחה אלא אם חיוני.
- לשאול מה מטרת כל לינק.
שימוש בכלי עזר - דוגמאות, טיפים, שימו לב, אזהרה, חשוב לדעת
דוגמאות
- דוגמה תופיע רק אם תורמת להבנה.
טיפים
- קיצורי דרך מועילים לתהליך או למידע.
שימו לב
- התרעות למניעת טעויות נפוצות.
אזהרה
- שימוש במשורה, רק היכן שיש סיכון ממשי.
כדאי לדעת
- מידע משלים שלא חיוני אבל עשוי להועיל.
פסקת שאלות ותשובות
- מתאימה להוספת הסברים לפרטים או מקרי קצה.
- מנוסחות בגוף ראשון בשאלה וגוף שלישי בתשובה.
אסמכתאות. פסיקה לא חלוטה
- הפניות לחוקים ולפסיקות בסוף הערך.
- לא לפתוח משפט ב"לפי החוק" או "לפי הפסיקה".
סעיפי חוק
- אזכור סעיפי חוק בסוף.
- הפניה דרך לינקים.
טבלאות
- כלי עזר להנגשה.
- להימנע מטבלאות עם יותר מ-5 עמודות.
- לוודא שהן קריאות גם במובייל.
עץ החלטות
- תהליך פיתוח פיצ'ר עתידי.
כלי עזר לעורכים/ות
רידביליטי
- מדידה של קריאות הטקסט והצעות שיפור.
קלריטי
- ניתוח עומק גלילה ולחיצות על לינקים.
AI
- סיוע ביצירת ניסוחים חלופיים.
כללי כתיבה פשוטה
- מילים פשוטות.
- משפטים קצרים.
- חיוב במקום שלילה.
- פעיל במקום סביל.
כתיבה משפטית פשוטה
- להבין את הסיכון המשפטי הקיים.
- להבדיל בין כתום, ירוק ואדום (סיכון גבוה/בינוני/נמוך).
סיכומי מפגש סדנת פישוט והנגשה 2024
- עדכונים ושיפורים לאחר הסדנאות.
דוגמאות לנושאים שונים במדריך
- הדגשת תועלת לקורא בדגשים.
ארגז חול
- מקום לרעיונות, מחשבות, דיונים.