לפעמים אין ברירה וצריך לרוץ קדימה ולא תמיד יש זמן לתעד הכל, לכן חשוב להתמקד תחילה במה שבאמת הכרחי ולהשלים את השאר בהדרגה.
דוקומנטציה הכרחית:
- טוקנים ויסודות: כל הדיזיין סיסטם נשען על יסודות, ולכן זה השלב ההכרחי ביותר. תעדו את מערכת הצבעים, טיפוגרפיה, מרווחים, בורדר רדיוס, עובי קו ואייקונים.
- תיעוד קומפוננטות: עבור כל קומפוננטה, הכרחי לכלול:
- שם: שם ברור ומדויק.
- הסבר קצר: תיאור מטרת הקומפוננטה והקשר השימוש שלה (מומלץ להוסיף לינק לסטוריבוק, אם יש).
- תיעוד וריאנטים: לדוגמה, פריימרי/סקנדרי, גדול/בינוני/קטן, סטייטים (כגון דיפולט, האבר וכו') ופרופרטיז (כגון עם/בלי אייקון).
- מאפיינים מרכזיים ומגבלות: כמו גודל מינימלי ומקסימלי.
Good to have – תיעוד שאפשר להוסיף בשלב מאוחר יותר:
- כללים והמלצות על שימוש נכון ברכיב, כולל עשו ואל תעשו, לדוגמה: מתי להשתמש בכפתור ראשי לעומת משני, וכמה כפתורים מקסימום לשים זה לצד זה
- פאטרנים נפוצים ודוגמאות שימוש שמראות את הרכיב בפעולה בקונטרסטים שונים, לדוגמה: איך משלבים כפתורים בטפסים, מיקום וסדר נכון של אישור וביטול
- הנחיות ותכונות נגישות, כמו גודל מינימלי ללחיצה ויחס קונטרסט מינימלי
- היסטוריית גרסאות שמתעדת שינויים של הקומפוננטות לאורך זמן
- קווים מנחים לכתיבה – הנחיות לטון, סגנון וכתיבת טקסטים
- הפניות לרכיבים דומים או משלימים שאפשר להשתמש בהם יחד
צריכים עזרה בכתיבת הדוקומנטציה? כאן אפשר להוריד את קובץ הטמפלט החינמי שלנו בקומיוניטי של פיגמה, שיחסוך לכם שעות של עבודה.
מהניסיון שצברנו 