מתחילים כאן
מרכז התיעוד של LinkNodes Energy
מפת המוצר, המערכות והמקורות — במקום אחד.
בעמוד הזה
מרכז התיעוד מרכז את הידע שנכתב על LinkNodes Energy: המוצר, ארבעת המסלולים, העיצוב והשפה החזותית, הסאונד, הנתונים, הארכיטקטורה, האינטגרציות, האבטחה והפלטפורמות. לצד המדריכים נמצאים מסמכי המקור המלאים, קטלוגים מובנים ורשומות שחרור.
המקורות הראשיים מוצמדים לגרסת המקור fb427598bb9ea78224f5858bb41b5d386317db9c. מסמכי פיתוח שטרם מוזגו נשמרים בנפרד עם גרסת המקור שלהם. התיעוד מתאר את הקוד ואת ההחלטות שנרשמו; מצב שירות חי דורש ראיות הפעלה נפרדות.
נקודות כניסה#
| מה רוצים להבין | מאיפה מתחילים |
|---|---|
| מה המוצר עושה ולמי | יכולות המוצר וספר מערכת המוצר |
| מה כולל כל מסלול | יכולות לפי מסלול, עם זכאות ומצב מסירה בכל שורה |
| איך המוצר בנוי | מחסנית הטכנולוגיה וספר הארכיטקטורה |
| אילו חיבורים קיימים או נדרשים | מפת האינטגרציות |
| איך מגינים על חשבונות ונתונים | אבטחה, זהות ופרטיות |
| איך המוצר נראה ומגיב | Design System, Visual System ומערכת הסאונד |
| איך נשמרים נתונים ומחושבים דוחות | ספר מערכת הנתונים ויומן האנרגיה |
| מה תוכנן לניהול החברה | טיוטת Admin, Finance וRevOps |
מוצר אחד, כמה משטחי שימוש#
הרפוזיטורי מתעד אתר חברה, מוצר ללקוחות, כניסה מוגנת לניהול החברה ואפליקציית מובייל. המרחבים האישיים והעסקיים משתמשים במקורות הרשאה ונתונים מוגדרים. מפה, תיעוד ספק או מחירון אינם כשלעצמם אישור להפעיל עמדה או לגבות תשלום. מפת הרפוזיטורי מתארת את החלוקה ואת נתיבי המקור.
Personal ו־Family מיועדים למרחב אישי; Business ו־Enterprise למרחב עסקי. יש להבחין בין מסלול החשבון, תפקיד המשתמש, הרשאה לפעולה והפעלת אינטגרציה. תפקיד Finance, למשל, אינו מסלול מנוי נפרד. הפרטים נמצאים במפרט המוצר ובתיעוד מסלול החשבון.
ארבעה סוגי תיעוד#
- מדריך: הסבר שמחבר מקורות ומכוון למסמכים המלאים.
- תיעוד מקור: מסמך או קטלוג שנשמר בקוד. הוא עשוי לכלול גם תכנון ותלויות שטרם הושלמו.
- טיוטה: מפרט מוצע, טקסט לחנות או עבודה בענף שטרם מוזג; אינו אישור להפעלה.
- תיעוד היסטורי: תוצאות או החלטות בזמן שחרור מסוים, עם ההקשר המקורי שלהן.
בכל מסמך מוצגים המקור והסטטוס שלו. מדריך הקריאה מסביר איך להכריע כשמסמכים מתקופות שונות מתארים מצבים שונים.
גבולות המוכנות המתועדים#
העמלה המאושרת בקטלוג המסחרי היא 0.99% לפני מע״מ בכל ארבעת המסלולים. מקור התמחור עדיין מסמן גבייה כלא פעילה; מסמך HYP מפרט את דרישות ההפעלה. הפעלת טעינה אצל ספק, סליקה, מסמכים חשבונאיים וחיבורי תקשורת אמיתיים דורשים חוזים, הרשאות ואימות נפרדים. הארכיטקטורה המסחרית ומסמך HYP מתארים את ההפרדה.
הדשבורד, Finance ו־RevOps של החברה מופיעים כאן עם מסמכי הפיתוח שלהם. כל עוד המקור מסומן טיוטה, אין לקרוא בו הצהרה על שימוש בנתוני החברה בפרודקשן.