המדריך ל… כתיבת מדריך “עשה זאת בעצמך”

טכנולוגיה מתקדמת

איך לכתוב מדריך עשה זאת בעצמך ולהשאר בחיים – בעקבות ריבוי החוקרים (19) וריבוי החוקרים האורחים (30!) עלה בי הצורך ליישר קו ולייצר סטנדרט לתיעוד. מתוך כבוד לדרך האישית שבה כל חוקר וחוקר אוהב ומסוגל לתעד הבנתי שראוי שהסטנדרט ישמש יותר כהמלצה לתבנית מאשר טופס נוקשה. אפשר לראות את המדריך הזה יותר כצ’ק ליסט למדריך טוב בשילוב דוגמאות בתוך האתר שממחישות את כוונתי.

איך לכתוב מדריך עשה זאת בעצמך ולהשאר בחיים

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

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

חשוב, לא כל הסעיפים ברשימה הנם בעלי אותה חשיבות. לכן, אתן לפני כל סעיף ניקוד (2, 5, 10) – לא כדי לספק ציון מספרי למדריך אלא כדי שיהיה לכולנו (עבור עצמנו) קל להשוות בין מדריכים, על בסיס מדד אחיד. אפשר לראות את זה כסוג של “בחן את עצמך: האם המדריך שלך מעולה?”.

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

רגע לפני, מהו מדריך?

מדריכים הם הליבה של “בידיים”, הגביע הקדוש. מדריך הנו תיעוד של אוסף פעולות שמלמדות, צעד אחר צעד, איך להגיע מא’ לב’. מדריך טוב (וזה מתקשר לנו להמשך) הוא מדריך שקל מאוד (ועד “חסין טעויות” או Dummy proof) לשכפל את התוצר של המדריך. בדיוק כמו שמתכון טוב לתבשיל (מעבר להיותו טעים) הוא כזה שברור לגמרי איך לקיים בו את כל השלבים, ומספיק שיש לנו שתי ידיים, כלים מתאימים ולפחות עין אחת עובדת כדי לצפות/לקרוא/לשמוע את המדריך, נוכל לבשל את התבשיל לרמת דיוק מקסימלית.

להלן הסעיפים.

מטא-מדריך

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

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

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

4. (5 נק’) האם המדריך ייחודי באתר?
האם באתר שלנו (“בידיים”) הנושא עוד לא תועד? או לחילופין, אוזכר במאמר או מדריך אחר אך לא ניתן מענה למקרה המיוחד שבו המדריך שלכם עוסק?

5. (5 נק’) האם המדריך משפר מדריך קיים באתר?
יוצא מן הכלל עבור הסעיף הנ”ל – האם המדריך הינו שיפור של מדריך קודם או ווריאציה שלו, כשהמדריך החדש מתייחס למדריך הקודם, כמו המדריך לבניית חוות חלון Window Farm של יואב ואייל, שממשיך אותו מדריך המשך של מייק, עוד על חוות חלון, הגירסא הלוטנ-ית.

6. (10 נק’) האם החומרים הנחוצים למדריך נגישים לציבור הרחב?
האם קל להשיג, בחינם או בכסף, את החומרים שבהם בחרתם להשתמש בפרויקט? למשל, תנור סולארי שבנוי כמעט אך ורק מפסולת, יהיה עדיף על תנור סולארי שיש לרכוש חומרי גלם עבורו.

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

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

מידע כללי

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

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

11. (10 נק’) האם קיימת תמונת אצבע?
(5 נק’) האם תמונת האצבע תורמת מידע וויזואלי מקדים אודות תוכן המדריך?
(2 נק’) האם תמונת האצבע מסקרנת מספיק?
תמונת אצבע היא התמונה אותה ייראו בכל מקום שבו מופיע התקציר של המדריך – בדף הראשי, בדף החוקר, בגלישה בין המדריכים, ועוד… אפילו בניוזלטר. על כן, מאוד חשוב שתהיה תמונת אצבע למדריך. שנית, כדאי שהתמונה תספק מידע נוסף אודות תוכן המדריך – למשל, אם מדובר בתנור שמש, או מערכת כזו או אחרת, רצוי שהאלמנט המדובר יהיה מצולם.

12. (2 נק’) האם צויינה רמת קושי?
(5 נק’) האם צויין ידע נדרש?
(5 נק’) האם תועדה עלות?

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

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

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

13. (10 נק’) האם תועדו חומרים נדרשים?
(10 נק’) האם תועדו כלי עבודה נדרשים?
רשימות חומרים וכלי עבודה הן חשובות עד מאוד, במיוחד במדריכים מאוד טכניים ו/או מדריכים עם הרבה חלקים ורשימת רכיבים ארוכה. חשוב לחשוב על כל תהליך הפרויקט, מההתחלה ועד הליטוש האחרון, כדי לעשות רישום מדויק של כל מה שהשתמשתם בו. במדריכים בהם יש רשימת חומרים ארוכה ומאוד ספציפית, כדאי להוסיף תמונה של כל החומרים (לזכור לצלם אחת כזאת לפני שבניתם!) ולהסביר את התמונה בגוף המדריך, כמו שעשיתי במדריך איך לבנות חותך זכוכית.

הקדמה

14. (5) האם קיימת תמונה בתחילת המדריך המציגה את היעד הסופי (אולי תמונת האצבע)?
תמונה סופית של הפרוייקט בתחילת המדריך יכולה לעזור לקורא להבין לאן הולכים, מה הולכים לבצע, ואיך נראה הפרויקט בסוף. תמונה סופית מאפשרת לראות את “התמונה הגדולה” כשבדרך כלל בתוך המדריך עצמו מתמקדים בפרטים מאוד קטנים. לרוב קשה להבין איך הפרטים מתחברים אם לא רואים את התמונה הגדולה. למשל, במדריך של יואב אודות גידול עץ שטוח בהדליה על הקיר, מאוד עוזר לראות את התמונה הגדולה בהתחלה.

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

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

שלבים

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

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

19. (10) האם בכל שלב יש לפחות תמונה אחת?
(2 על כל שלב) האם בכל שלב יש לפחות פסקה אחת?
(2 על כל שלב) האם התמונה/ות מעניקה/ות עוד מידע וויזואלי על השלב?
כל אדם והמדיה שבה הוא מצליח לקלוט מידע: האחד צריך לראות מידע כתוב, האחר מבין דרך תמונות, ושלישי מעדיף לראות סרטון. הכי טוב – לשלב. סרטונים קצת יותר קשה להפיק, במיוחד אם לא נוח לכם מול המצלמה, אך היום כבר כל אחד יכול לייצר תמונות קפואות (מה שנקרא Stills) בקלות ובאיכות גבוה. כדאי להוסיף תמונה עבור כל שלב – הרי תמונה שווה אלף מילים, לא? ומצד שני, לא כדאי לוותר על הטקסט, כי לעיתים תמונות הן חסרות, וטקסט יכול לבאר מה רואים בתמונה.
אבל, כמובן – לא סתם תמונות. התמונות צריכות להעניק מידע וויזואלי על המדריך עצמו. אם התמונה קטנה ומטושטשת או שהיא מצחיקה והומוריסטית אך לא ממש מספקת מידע חשוב לקורא – במצב כזה, התמונה גורעת יותר מאשר תומכת. חשבו על זה.
שימוש טוב בתמונות אפשר לראות במדריך בניית תנור השמש SunSlider.

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

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

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

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

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

סיכום

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

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

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

פוסט-מדריך

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

לסיכום…

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

חידוד ההבדל בין מדריך, מאמר, סיקור ותגית

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

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

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

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

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

מקורות

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

מה עושה מדריך טוב?

לתוכן זה נכתבו 3 תגובות

עליך להתחבר כדי לבצע פעולה זו...

הצטרפות

דילוג לתוכן