תיעוד אתר הוא מסמך — או כמה מסמכים — שמסביר איך האתר בנוי, איפה כל רכיב נמצא, למי יש גישה ומה עושים כשמשהו משתבש. אתר בלי תיעוד תלוי בזיכרון של מי שבנה אותו: כשהמפתח לא זמין, כשהעסק מחליף ספק או כשהאתר נופל בשתיים בלילה, אף אחד לא יודע איפה הדומיין רשום, מה הסיסמה לשרת או למה התוסף הזה מותקן. תיעוד טוב לא חייב להיות ארוך; הוא חייב להיות מדויק, מעודכן ונגיש לבעל האתר.
מה צריך להיות בתיעוד
| חלק | מה כולל | למה זה חשוב |
|---|---|---|
| רשימת נכסים וגישות | דומיין, DNS, אחסון, מייל, Cloudflare, אנליטיקס, Search Console — איפה כל אחד ועל שם מי | בלי זה אי אפשר להחליף ספק או לטפל בתקלה |
| ארכיטקטורה | פלטפורמה, תבנית, תוספים ולמה כל אחד מותקן, מבנה התוכן | מונע מחיקה של רכיב "מיותר" שמשהו תלוי בו |
| חיבורים חיצוניים | שירותים שהאתר מתחבר אליהם, איפה המפתחות נשמרים, מי משלם | חיבור שנשכח הוא חיבור שנשבר בשקט |
| גיבויים | מה מגובה, איפה, כל כמה זמן, ואיך משחזרים | גיבוי שאף אחד לא יודע לשחזר לא שווה הרבה |
| נוהל תקלות | מה בודקים כשהאתר לא עולה, למי פונים | חוסך שעות ברגע הלחוץ ביותר |
| מדריך עריכה | איך מוסיפים עמוד, מאמר, מוצר; מה לא לגעת בו | מאפשר לעסק לעבוד עצמאית |
רשימת הנכסים: החלק הכי חשוב
אם יש זמן רק לחלק אחד, זה החלק. לכל נכס רושמים: איפה הוא מנוהל, על שם מי הוא רשום, מי משלם, מתי מתחדש, ואיפה נמצאים פרטי הגישה. הסיסמאות עצמן לא נכתבות במסמך — הן נשמרות במנהל סיסמאות, והמסמך מפנה אליו. כך גם החלפת סיסמה לא דורשת עדכון של התיעוד.
הכלל החשוב ביותר: הנכסים הקריטיים — ובראשם הדומיין — רשומים על שם העסק, לא על שם המפתח או הספק. אצלי הדומיין נרשם על שם הלקוח והקוד שייך לו. מה עוד צריך לקבל בסוף פרויקט מפורט במאמר בעלות על אתר: מה צריך לקבל.
ארכיטקטורה ותוספים
לכל תוסף או רכיב מותקן כותבים שורה אחת: מה הוא עושה ולמה הוא נחוץ. זה נשמע מיותר, עד שמישהו מוחק תוסף שנראה מיותר והטופס באתר מפסיק לשלוח פניות. באתרים מורכבים יותר מתעדים גם את מבנה התוכן — סוגי תוכן, שדות, טקסונומיות — ואת מבנה הכתובות. ראו סוגי תוכן בוורדפרס ואיך בוחרים תוספים.
נוהל תקלות קצר
עמוד אחד שעונה על "האתר לא עולה — מה עושים?": מה בודקים קודם (דומיין, DNS, תעודת SSL, השרת, האתר עצמו), איפה רואים את מצב השרת, איך מגיעים לגיבוי האחרון, ולמי פונים. הסדר המלא מפורט במאמר האתר לא עולה: סדר הבדיקה, ועל שחזור במאמר שחזור אתר מגיבוי.
תיעוד שינויים
מעבר למסמך הקבוע, כדאי לשמור יומן שינויים: מה השתנה, מתי ולמה. כשמשהו נשבר, השאלה הראשונה היא "מה השתנה לאחרונה?" — ויומן כזה עונה עליה בשניות. באתרים שהקוד שלהם מנוהל בגרסאות, ההיסטוריה של מאגר הקוד ממלאת חלק גדול מהתפקיד הזה — ראו ניהול גרסאות לאתר.
איך שומרים את התיעוד מעודכן
- במקום אחד שבעל העסק יכול לגשת אליו — לא במייל ישן ולא במחשב של המפתח.
- מעדכנים עם כל שינוי — תוסף חדש, חיבור חדש, ספק חדש.
- בודקים פעם בשנה — עוברים על רשימת הנכסים ומוודאים שהכול עדיין נכון: מי הבעלים, מתי החידוש, מי עדיין צריך גישה.
- קצר עדיף — מסמך של עמוד שמתעדכן שווה יותר ממסמך של שלושים עמודים שאף אחד לא קורא.
שאלות נפוצות
אתר קטן צריך תיעוד?
כן — לפחות רשימת נכסים וגישות. דווקא באתרים קטנים, שבהם אדם אחד יודע הכול, התיעוד הוא מה שמונע תלות מוחלטת באדם הזה.
איפה שומרים את הסיסמאות?
במנהל סיסמאות, עם שיתוף מבוקר. לא במסמך, לא בגיליון ולא בהודעות וואטסאפ.
בסוף כל פרויקט אני מוסר רשימת נכסים וגישות ותיעוד של מבנה האתר, והדומיין רשום על שם הלקוח. אפשר לקרוא על תחזוקת אתרים, או לכתוב לי.
אהבתם את המאמר?
