←כל התיעוד
פורטל Studio

לבנות באומץ.

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

מסמך פורטל V2מנהל + Developerשחרור שוק העבודהUpdated 1 August 2026
מדריך אדריכלות

לדעת מה סטודיו

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

עזרה למרכז + כרטיסי אשראיהתאמת נתונים בטוחהפורטל Document v2 טיוטהאחד הספידר והמפיקPreview and Published Portal
חוק אחד: דפי תצוגה מקדימה וציבור משתמשים באותה חוזה מסמך/קומבר.פרסום אף פעם לא עובר לתבנית שאינה קשורה.
פורטל: מפת החלל
Live הבדשולחן העבודה
פורטל לקוחותאותו מסמך מובנה המשמש בתצוגה מקדימה ופרסום
מפת הממשק: רכבת העבודה, בד חיה ומפקח מכוונים לאותו דף יציב ובחירת צומת.
מנהל: התחל

מוכנות מלאה לפני בניית

  1. פתוח פורטל Studio→התחל להתחיל→Readness.
  2. לאשר את כתובת פורטל הקנון ולפתוח אותו בכרטיסיה נפרדת.
  3. הגדר את הלוגו, סמל הדפדפן, סמל מגע, תדמית חברתית וצבע נושא.
  4. אישור שפות מרכז עזרה; שינוי סמכות שפה במרכז העזרה, לא סטודיו.
  5. ניווט קונדס ו- Global Enterprise Footer
  6. בחרו מסע כרטיסים והגדרתו לפחות טופס בקשה אחד.
  7. שמור לפחות אחד בטוח שיטת זיהוי זהה פעיל ולבחון.
  8. הפעל איכות והקמת לחיצת יד מקדימה חתומה.
  9. יצירת השחרור הראשון הנשלט לאחר כל פריט חסום ברור.

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

• Build

לבנות דפים וקטעים הניתנים לחזרה

  1. פתוח לבנות→דפים בחר דף מערכת מוגן או ליצור דף מותאם אישית.
  2. הגדר את המסלול, הכותרת, מצב הגישה והתנהגות מקומית.כבישים במערכת מוגנים לא ניתן למחוק.
  3. פתוח רכיביםמסנן על ידי עבודה או בגרות, ומניח מרכיב בחיק מתאים.
  4. השתמש במפקח לתוכן, מראה, מחייב, חשיפה ונגישות.
  5. השתמש בדפוסים הניתנים לחזרה למבנים חוזרים; לשמור על הבדלי הארגון או המותג בגרסאות.
  6. שמור את הטיוטה ואת טעינת התרגיל, ריק, שגיאה, אורח וחתומה במדינות בתצוגה מקדימה.
האותיות הקטנות של Sanitized Interface Map
ידע חיפוש• לקוחות בטוחיםקטגוריהמרכז עזרהסעיף גוףתרגום DTOבקשה טופסתגית: GAכרטיס Timelineאזהרהתרשים נתונים« בלוקים
מפה לממשק: קטגוריה, תאימות ובשלות גלויים לפני המיקום.רכיבים מתוכננים לחסום פרסום; רכיבי בטא דורשים טיפול מפורש שחרור.
ניהול ותגובה

צפייה במסעות אמיתיים, לא מסך מאושר

  1. בחר תמיכה באורח, כרטיס חתום, טיפול חיוב, ארגון או ידע.
  2. Switch Personas, ארגון, תפקיד ושפת מרכז העזרה.
  3. Inspect Mobile, גדול נייד, Tablet, מחשב נייד, שולחן עבודה, נקודות רחבות ורחבות.
  4. בדוק את ערכי ה-Overridden and reset; להימנע משכפול חסר צורך.
  5. הפעל מקלדת, RTL, מופחתת-תזונה, טעינה, ריקה, לא זמינה ורשאות.
  6. השתמש במעבדת מבחן עבור נגישות, תשלום, מסלול, מחייב ותוצאות הגשה לפני בחינה.
בד ירוק אינו החלטה לשחרור.העברה מאוישת, מדינת ביקורת, יכולות וגילויי שחרור מחליטים האם פורטל עשוי לפרסם.
ניסיון

פתח מרכז עזרה ברמת Zendesk ללא תוכן כפול

  1. יצירת קטגוריות, קטעים, מאמרים, תרגומים, קבצים מצורפים ותבניות ב מרכז עזרה.
  2. שפות זמינות שם; סלוגים מקומיים, חיפוש, להאכיל, SEO ומאמר chrome עוקבים אחר אותה סמכות.
  3. באולפן, מקום חיפוש ידע, קטגוריות / מקורות רשת, הזנות, נספח נושא, מאמר, שולחן של תוכן, משוב, הקשורים ורכיבים קודמים/באים.
  4. תצורה שהוצגה, הזנות פופולריות ואחרונה; השתמש בהצעות קונטקסטואליות בתזרימי הכרטיסים.
  5. Preview no-results, מאמרים ארוכים, החזקות, משוב, שעון / ספאם וכרטיס יד.
  6. בדוק מסלולים מקומיים נקיים, canonical /hreflang, נתונים מובנים ו invalidation לאחר פרסום.
גבול הרשות: לערוך תוכן מאמר ושפות לקוחות במרכז העזרה. השתמש בפורטל סטודיו רק כדי להלחין את הידע שהתגלה ולהציג אותו.
ניהול זהות וארגונים

המונחים: בבטחה

  1. פתוח זהות וארגונים→זהות שמור לפחות על אחד הנתיבים.
  2. בחר שיטת ברירת מחדל, מדיניות רישום, משך ישיבה SSO התנהגות של אכיפה וגילוי.
  3. הוסף ספקים עם שדות קידוד חזותי: סוג, תחומים, עדיפות, מצגת, מדינה מופעלת ואומתית סודות להישאר במערכת זהות.
  4. For SCIM, לאפשר מתן, העתק את נקודת הקצה של סביבת העבודה המדויקת ולסובב את הסימון.חנות את האסימון חד פעמי ב- IdP.
  5. תביעות מפה וחברות ארגוניות, לאחר מכן מבחן ליצור, לעדכן, חברות קבוצתיות ופעולות עם דייר מבחן.
  6. אורח, לקוח, ארגון מוקצה וההגבלות חסומות לפני פרסום.
לעולם אל תשלח עוגיה לסטודיו SCIM זהו נושא ללא הישיבות, סביבת העבודה API רוטט אסימון לאחר חשיפה מקרית.
מסעי כרטיסים

עקבו אחרי AllMusic Journey

  1. בחר טופס ישיר, קוסם, חיפוש ראשון, מרכז או כניסה של שירות.
  2. צור טופס בקשה בשם, גרסה מעודכנת עם חלקים ותוויות שדה נגישות.
  3. בנה תנאים חזותיים, מחיקה, SLA ופעולות אישור; מתקדמים JSON הוא מיועד לשינויים במפתח בלבד.
  4. הגדרות רשימה, פרטים, נושאים, קו זמן, ציטוט, אישור, SLA ומשטחי תשובה. Name
  5. בדיקת אורח, בקשות חתום, חשיפה ארגונית, העלאה של כשל, הודעת דואר אלקטרוני והשתקפות ידע.
  6. שמור טיוטה; לפרסם רק לאחר המודול מתאם והודעת נתיב לעבור לפני הטיסה.
ניהול ושחרור

לעבור דרך שחרור נשלט

דאף הצילבסקירהאושרתזמון או פורסםאו שגלגל בחזרה
  1. הפעלת אימות ומעבדת Test. Fix לחסום את הממצאים; להכיר אזהרות מותרות עם ההקשר.
  2. הוסף הערות שחרור ובקשה סקירה. Reviewers להגיב על מסלולים יציבים דף / לאדה.
  3. אישורים בודקים את המסעות המקדימה, שינויים באישור וראיות.
  4. לוח זמנים או לוח הזמנים באמצעות עובד רקע.יציאה מסטודיו לא מבטלת עבודה יציבה.
  5. צפה בהתקדמות, בריאות וזיהוי קורלציה.עצור/retry רק משליטה בעבודה.
  6. בדוק מסלולים קריטיים, זהות, כרטיסים וידע.ר.רול חזרה להודעה קודמת בלתי-מוגדרת בעת הצורך.
יכולת Capabilityמטרה
תגית: Editהוראות או שינוי ללא רשות שחרור.
ביקורת / Aprovמשוב נפרד ואישור מסמכות.
תגית: Publish / Rollbackפיקוח על ייצור עצמאי
זהות / SCIM / Migrate / Components / Diagnosticsהגבלות פעילות מומחה רגישה
ניהול ורחב

למד עם ראיות והדרך חזרה

  1. בחר את מדפסת ה-Blueprint של הספק ויצור ריצה יבשה.
  2. עיין בהגדרות, ערכים לא ממופים, ספירות תוכן ולכידת parity חזותי.
  3. מיפוי בטוח לחלוטין ושיקום הקובע המובנה.
  4. החל טיוטה, ליישב ספירות ותצוגה מקדימה כל מסע מוגן.
  5. רישום קבלה מורשה; לעולם אל תכתבו את השחרור שפורסם לאחרונה במהלך היבוא.
  6. עבוד באמצעות ממשל ושמור את דוח ההגירה, לשחרר זהות ונקודת רולבק יחד.
אדריכלות: Architecture

חוזים מתקדמים, לא תבניות

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

מסמך פורטל V2

דפים מכילים צמתים יציבים, חריצים, תכונות, מחייבות, חסרונות תגובתיים, תנאים ו metadata נגישות.

הרשמה

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

מקור נתונים

מאפשר, קורא-רק, הרשאה-פיקד DTO להחליף שרירותי SQL או פעולות דינמיות.

אחד המונחים

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

המונחים: Component contract

Define a רכיב החבילה

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

{
  "schema_version": 1,
  "id": "acme.support_health",
  "slug": "acme-support-health",
  "name": "Support health",
  "version": "1.0.0",
  "entry": "renderer.php",
  "renderer": "server",
  "server_renderer": "renderer.php",
  "public_renderer": "public.js",
  "schema": {
    "type": "object",
    "properties": {
      "heading": {"type": "string", "maxLength": 120},
      "showSla": {"type": "boolean", "default": true}
    },
    "additionalProperties": false
  },
  "permissions": ["tickets.read"],
  "data_scopes": ["tickets.mine"],
  "accessibility": {
    "landmark": "section",
    "nameFrom": "heading",
    "emptyState": true,
    "errorState": true
  },
  "performance": {"max_js_bytes": 12000, "max_css_bytes": 8000},
  "performance_budget": {"js": 12000, "css": 8000, "requests": 0}
}

צורת צמת

{
  "id": "node-support-health",
  "type": "custom.acme_support_health",
  "props": {"heading": "Support health", "showSla": true},
  "bindings": {"requests": {"source": "tickets.mine", "limit": 5}},
  "responsive": {"mobile": {"padding": "16px"}, "desktop": {"padding": "24px"}},
  "conditions": [{"field": "identity.signed_in", "operator": "equals", "value": true}],
  "a11y": {"label": "Support health"}
}
  • תעודות זהות נותרו יציבות בעריכה וגירדות.
  • נכסים דוחים שדות לא ברורים ולא בטוחים HTML.
  • כל מבט של נתונים מגדיר טעינה, ריקה, הרשאות ותפוקה חוזרת של טרור.
  • מרכיבים המכילים שם את חריצים שלהם; עלים לא יכולים לקבל ילדים שרירותיים.
  • מרק בגרות: בלוקים מתוכננים, בטא מזהירה, GA דורש ראיות מלאות.
מקורות נתונים וגורמים

שימוש ב- DTOS

  1. בחרו מזהה קיים כגון tickets.mine, knowledge.featured או customer.profile.
  2. רק שדות שהכריזו על ידי הגירסה שלו DTO.מקורות לא ידועים נכשלים עם מקורות בלתי ידועים data_source.unknown.
  3. לעבור את ההקשר פורטל מורשה כבר; לעולם אל תקבל זהות עבודה / לקוח מנכס לא מהימן.
  4. גבולות הרשימה מותקפים1–100.נרמל את הדמיון, המקומי וערכי החיפוש.
  5. אם מקור חדש הוא בלתי נמנע, להוסיף את ההגדרה היציבה שלו, מיפוי בטוח, הרשאות, התנהגות ריקה ותיקון תצוגה מקדימה יחד.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
מקורות נתונים הם לקריאה בלבד.מוטציות דורשות פעולה שירות מורשה מפורשת, המחייבת חלל עבודה, CSRF/session או אישור דובר, idempotency שבו יש צורך ומעטפה שגיאה קלה.
פיתוח: אבטחה

הישארו בתוך גבולות האמון

ממזרהתנהגות נדרשת
סביבת עבודהלפתור מהמארח / הדרכונים המוערכים, ולאחר מכן למקם כל קריאה וכתיבה לפני ביצוע.
HTMLUse the Portal sanitizer/parser allowlist. Never concatenate untrusted attributes, URLs, CSS or script.
ביקורתנדרש חלון מקור זהה של אותו מקור, חתימה על גרסת ערוץ ו nonce. Ignore unsolicited הודעות.
זהותשמור סודות מחוץ למסמכים. SCIM הוא דובר-אוהותי, ללא הישיבות ומרחב העבודה.
חבילותמסלולים מתמשכים, נתיבים מוחלטים, קישורים / קבצים מיוחדים, ארכיוןים בגודל יתר, בדיקותum/signature לא מתאים ורשאות לא ידועות.
טעויותהחזרת קוד יציב, מסר בטוח, דחייה וזיהוי קורלציה; לפרט חריגים פרטיים בצד השרת.
ידעקרא באמצעות HelpCenterBridge. Never Author או לשכפל מאמרים במרכז העזרה בהרחבה.
{
  "success": false,
  "error": {
    "code": "studio.permission_denied",
    "message": "You do not have permission to publish the Portal.",
    "retryable": false,
    "correlation_id": "ps_…",
    "meta": {"capability": "publish"}
  }
}
פיתוח: חבילה וההגירה

Inspect, להתקין ולשפר מבחינה אטומית

  1. לשים component.json בשורש ZIP, לשמור על כל נתיב יחסי.
  2. הפעל בדיקה ראשונה.The Installer caps Archives at 500 ערכים ו 25 MB מיצוי; אימות אבטחה מוסיף מגבלות עצמאיות.
  3. Verify the expected SHA-256 and package signature in the release process.
  4. התקן לבמאית גרסה מעודכנת. Never mutate an Install version in place.
  5. לספק הגירה רכוש על מנת לשבור שינויים סכימה ולשמור שדות תאימות לא ידועים.
  6. פתח את הרכיב בטיוטה, להפעיל כל תיקון מצב/ראייה/אישיות ופרסום באמצעות ממשל.
  7. רולבק מפעיל את שחרור הרכיב/ההביצועים הקודמים; לשמור על ראיות הכדאיות שלו.
מפתחים: בדיקות ושחרור

להוכיח את הסיומת על אותו שחרור ישה

php tools/portal_studio_certify.php --source-only --json
php tools/test_portal_studio_contract.php
php tools/test_portal_one_renderer.php
php tools/test_portal_studio_engineer.php
php tools/test_portal_component_contracts.php
php tools/test_portal_one_renderer.php
php tools/test_portal_shell_contract.php
php tools/test_portal_knowledge_contract.php
node node_modules/@playwright/test/cli.js test tests/e2e/portal-studio-shell-visual-contract.spec.js tests/e2e/portal-custom-code-runtime.spec.js

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

  • יחידה: סכמה, סניטובה, צורת DTO, תנאים, הגירה וכישלונות מטיפוס.
  • חוזים: טעינה / פחד / צואה, בגרות, חריצים, מחייבות ושוויון קטלני.
  • דפדפן: מקלדת, מיקוד, סמנטיקה, RTL, Zoom /reflow, תנועה מופחתת וכל נקודת הפסקה.
  • אבטחה: בדיקות חלל חוצה, פעולות מזויפות, התקפות חבילה, הצצה מקדימה ודליפה סודית.
  • פעילות: התקדמות ממושכת, יציאה / חזרה, עצירה / ריצה / מנוחה, פעימות לב לוח הזמנים וגלגל בחזרה.
ניהול + מפתחים - Recovery

פתרון בעיות על ידי המדינה ו- התכתבות מזהה

מדינת המדינהמה לעשות
רשותבקש את היכולת המוסתרת UI הוא נוחות; ה backend תמיד לאכוף אותו.
אימותפתח את הדף / Nde/field, לתקן אותו, ולאחר מכן ליזום מחדש את הטיסה.
סכסוךלנסח מחדש את התיקון האחרון, להשוות שינויים ובאופן מכוון.לעולם אל תאלץ לרסן את הטקס.
המונחים: retryableשמור על הטיוטה, לשחזר קישוריות, לעבור את הפעולה ולוודא מצב עבודה עמיד.
שומן / לא זמיןהעתק את מזהה התואם ואת הזמן דגימת התמיכה.לעולם אל תדביק סודות או טקסט יוצא דופן פרטי.
פובליש נכשלתפוקה טרום טיסה / עבודה, retry רק שלבים הניתנים לחזרה, או לחזור לשחרור בריא האחרון.
SCIM 401/403קצה/מרחב עבודה, טוקן דובים, מצב וסיבוב; לעולם אל תשתמש בקובץ cookie של ישיבת דפדפן.
ידע הוא staleבדוק את מקומי / פרסום במרכז העזרה, ולאחר מכן לבדוק אי-הסתערות מטמון ואת המסלול המקומי הנקי.

מדריך זה הוא Print-ready. Use Print→לחסוךPDFעבור עותק לא מקוון מבוקר