←Mọi tài liệu
Hướng dẫn trường điêu khắc cổng

Xây dựng một cách dạn dĩ.

Một tham khảo thực tế cho các nhà quản lý những người hình thành nên trải nghiệm khách hàng và phát triển những người mở rộng nó. nó tài liệu về kiến trúc phòng thu thật, con đường ra đời được điều khiển, giúp trung tâm sở hữu, nhân dạng, di cư, hợp đồng thành phần và phục hồi.

Tài liệu cổng v2Nhà quản trị + Nhà phát triểnLuồng công việc phát hành doanh nghiệpCập nhật 1 Tháng Tám 2026
Hướng dẫn quản trị · Kiến trúc

Biết studio sở hữu gì

Phòng thu cảng sở hữu vỏ bọc khách hàng: trang, vị trí thành phần, nhãn hiệu, hành vi trả lời, định hướng, chân vịt, trình bày danh tính, vé và phát hành. Trung tâm Trợ giúp sở hữu ngôn ngữ, phân loại, mục và bài viết. Phòng thu tiêu thụ nội dung đó thông qua một cầu được bảo vệ; nó không bao giờ tạo ra cửa hàng tạp chí thứ hai.

Dịch vụ định dạng trung tâm trợ giúp + véBộ thích nghi dữ liệu an toàn cho phépBản nháp tài liệu cổng v2Trình biên dịch và biên dịchXem thử và xuất bản Portal
Quy tắc một người. xem thử và trang công cộng sử dụng cùng một giao thức tài liệu/ bộ biên dịch. Việc công cộng không bao giờ chuyển sang mẫu không liên quan.
Bản đồ vùng làm việc cổng
Tranh trực tiếpTrình xem màn hình nền 2- 3
Cổng tự chọnTài liệu có cấu trúc giống nhau được dùng trong ô xem thử và dịch trước công chúng
Bản đồ giao diện: đường ray công việc, vẽ và thanh tra trực tiếp nhắm vào cùng trang ổn định và chọn nút.
Quản trị · Bắt đầu

Hoàn toàn sẵn sàng trước khi xây cất sâu sắc

  1. Mở Phòng thu Cổng→Bắt đầu→Đọc.
  2. Xác nhận địa chỉ cổng chính điển và mở nó trong một thẻ riêng biệt.
  3. Đặt biểu tượng, biểu tượng trình duyệt, biểu đồ cảm ứng, ảnh xã hội và màu sắc thái.
  4. Xác nhận Trung tâm Trợ giúp Ngôn ngữ; thay đổi thẩm quyền ngôn ngữ ở Trung tâm Cứu trợ, không phải Phòng thu.
  5. Cấu hình định vị và bộ chỉ huy toàn cầu.
  6. Chọn một chuyến đi và cấu hình ít nhất một đơn yêu cầu.
  7. Giữ ít nhất một phương pháp nhập an toàn hoạt động và xem xét lại việc khám phá danh tính.
  8. Chạy Chất lượng và thiết lập bắt tay xem thử đã ký.
  9. Tạo bản phát hành đầu tiên sau mỗi mục chặn rõ ràng.

Phần trăm sẵn sàng được tính từ dữ liệu không gian làm việc và trạng thái xem thử. Đang chọn một đường dẫn mục trực tiếp tới bảng làm việc riêng.

_Xây dựng người quản trị :

Xây dựng trang và phần có thể sử dụng lại

  1. Mở Xây dựng→Trang rồi chọn một trang được bảo vệ hoặc tạo một trang riêng.
  2. Đặt lộ trình, tựa đề, chế độ truy cập và hành vi cục bộ. Không thể xoá đường dẫn hệ thống đã bảo vệ.
  3. Mở & Bỏ giản đồ, nhờ công việc hay sự thành thục, và đặt một bộ phận vào một khe cắm tương thích.
  4. Dùng thanh tra để lấy nội dung, diện mạo, ràng buộc, tầm nhìn và khả năng truy cập.
  5. Dùng lại các mẫu cho cấu trúc lặp đi lặp lại; giữ tổ chức hoặc sự khác biệt thương mại về biến thể.
  6. Lưu bản nháp và tập thể dục nạp, trống, lỗi, khách và các trạng thái đã ký trong ô xem thử.
Sơ đồ giao diện thành phần l· Sanitized
Tìm kiếm kiến thứcGA· khách an toànLưới phân loạiTrung tâm Trợ giúp GA_·Thi thể bài viếtGA_· dịch DTOĐơn yêu cầuGA_· phiên bảnThời gian cho phép chọnBeta_· Cảnh báoBiểu đồ dữ liệuKhối đã được lên kế hoạch
Bản đồ giao diện: phân loại, sự tương thích và thành thục được thấy trước khi đặt. Ấn phẩm có dự định ngăn chặn thành phần; các thành phần beta cần thiết để giải phóng rõ ràng.
Quản trị hội nghị · Brand và hưởng ứng

Xem thử các chuyến đi thực, không phải một màn hình hạnh phúc

  1. Chọn sự hỗ trợ của khách mời, đăng ký vé, bảo hiểm hóa đơn, tổ chức hoặc giao cho kiến thức.
  2. Đổi người, tổ chức, vai trò và trung tâm hỗ trợ ngôn ngữ.
  3. Kiểm tra điện thoại di động, điện thoại, máy tính bảng, laptop, màn hình, điểm ngắt rộng và cực lớn.
  4. Kiểm tra những giá trị thừa kế, bị đè nén và đặt lại; tránh sự lặp lại không cần thiết.
  5. Chạy bàn phím, RTL, giảm chuyển động, tải lên, trống, không có và quyền hạn.
  6. Dùng phòng thí nghiệm để truy cập, nạp đạn, đường đi, kết nối và thực hiện các phát hiện trước khi xem xét.
Một bức tranh xanh không phải là một quyết định được ra mắt, mà là được điều hành trước khi bay, xem xét tình trạng, khả năng và công bố bằng chứng quyết định liệu Portal có thể xuất bản hay không.
_Kinh nghiệm quản trị :

Cho chạy một Trung tâm Trợ giúp Trung tâm Trung tâm Cứu trợ Zendesk mà không có nội dung sao chép

  1. Tạo phân loại, mục, bài, bản dịch, sự gắn kết và mẫu trong Trung tâm Trợ giúp.
  2. Kích hoạt ngôn ngữ ở đó; các ốc sên cục bộ, tìm kiếm, cung cấp dữ liệu,SEOvà bài Crome cũng làm theo cùng một thẩm quyền.
  3. Trong studio, tìm kiếm vị trí, mạng lưới kiến thức phân loại/ mã nguồn, dữ liệu, đối tượng, bài báo, bảng nội dung, phản hồi, liên quan và các thành phần trước.
  4. Cấu hình các tài liệu, được ưa thích và gần đây; dùng những đề nghị theo ngữ cảnh trong các dòng vé.
  5. Xem thử không có dấu hiệu, bài viết dài, đính kèm, phản hồi, xem/ bản thảo và bỏ vé.
  6. Kiểm tra các tuyến đường locale sạch, canonical / hreflang, dữ liệu cấu trúc và cache không hợp lệ sau khi xuất bản.
Giới hạn uy quyền: soạn thảo nội dung bài và ngôn ngữ khách hàng trong Trung tâm Trợ giúp. Dùng Phòng thu Cổng chỉ để soạn thảo cách phát hiện và hiển thị kiến thức.
Quản trị · Nhận dạng và tổ chức

Cấu hình các thiết lập cache ở đây. Name

  1. Mở & Tổ chức nhận diện→Nhận diện và giữ ít nhất một dấu hiệu được bật.
  2. Chọn phương pháp mặc định, chính sách đăng ký, thời gian phiên chạy, SSO- vẫn thực thi và khám phá hành vi.
  3. Thêm nhà cung cấp với trường định tuyến hình: kiểu, miền, ưu tiên, trình bày, được bật và xác nhận trạng thái. Bí mật nằm trong hệ thống con của danh tính.
  4. Vì SCIM bật khả năng cung cấp, sao chép điểm kết thúc không gian làm việc chính xác và xoay thẻ tín hiệu. Hãy lưu biểu tượng một lần vào IP.
  5. Bản đồ yêu cầu và tổ chức thành viên, rồi kiểm tra tạo, cập nhật, nhóm thành viên và cắt giảm hoạt động với người thuê thử nghiệm.
  6. Khách xem thử, khách hàng, ủy quyền tổ chức và các bang bị chặn trước khi xuất bản.
Không bao giờ gửi cookie phiên chạy tới SCIM Đó là một người không có kinh nghiệm, làm việc ngoài không gian API Xoay một vật kỷ niệm sau khi bị lộ.
Quản trị phi hành trình bằng vé

Tập hợp toàn bộ hành trình hỗ trợ

  1. Chọn dạng trực tiếp, pháp sư, tìm kiếm- thứ nhất, giữa hoặc mục nhập dịch vụ-desk.
  2. Tạo một tên, phiên bản đơn yêu cầu với các phần và nhãn trường có thể truy cập.
  3. Xây dựng điều kiện hình ảnh, định tuyến, các bước SLA và phê duyệt; JSON là để xem xét sự thay đổi của nhà phát triển.
  4. Cấu hình danh sách, chi tiết, chỉ, dòng thời gian, sự gắn bó, sự chấp thuận,SLAvà các bề mặt trả lời.
  5. Kiểm tra khách mời, yêu cầu nhập khẩu, tầm nhìn tổ chức, tải lên thất bại, thông báo email và sự lệch hướng kiến thức.
  6. Lưu bản nháp; xuất bản chỉ sau khi người thích nghi lộ trình và thông báo qua trước khi cất cánh.
_Xem lại và phát hành

Chuyển qua một bản giải thoát được điều khiển

Đã lưu nhápĐể xem xétĐược chấp nhậnĐã lên lịch hay đã xuất bảnĐã quan sát hay đã lăn ngược
  1. Chạy kiểm tra xem có đúng không. Sửa chữa các kết quả tìm kiếm; nhận những lời cảnh báo có ngữ cảnh.
  2. Thêm các ghi chú và phê bình yêu cầu. Những người xem lại ghi chú trên các đường dẫn chuẩn trên trang/ nút.
  3. Những người chấp thuận kiểm tra các chuyến đi, xem thử, sự thay đổi và bằng chứng.
  4. Xuất bản hoặc sắp xếp lịch trình qua người làm nền. Việc rời khỏi studio không hủy bỏ việc làm bền bỉ.
  5. Xem tiến trình, y tế và ID tương quan. Dừng/ bánh xe chỉ từ kiểm soát công việc.
  6. Kiểm tra các tuyến đường quan trọng, danh tính, vé và kiến thức.
Khả năngMục đích
Xem/ SửaKiểm tra hoặc thay đổi bản thảo mà không cần phải phóng thích quyền hạn.
Xem lại / Phụ lụcSự phản hồi và sự chấp thuận từ tác giả.
Lịch/ Công bố/ Quay lạiĐiều khiển sản xuất độc lập.
Danh tính / SCIM / Migrate / các thành phần / Chẩn đoánNhững hoạt động chuyên gia nhạy cảm bị hạn chế.
Quản trị ..

Đánh lạc hướng bằng chứng và quay lại

  1. Chọn bản thiết kế nhà cung cấp và tạo một đường chạy cạn.
  2. Xem lại các thiết lập đã khám phá, giá trị chưa được vẽ, nội dung tính toán và sự lấy đi bằng hình ảnh.
  3. Hoàn thành bản đồ an toàn và chạy lại cấu trúc phân chia.
  4. Áp dụng cho một bản nháp, tính hòa giải và xem trước mỗi chuyến đi được bảo vệ.
  5. Ghi âm cho phép chấp nhận; không bao giờ ghi đè lên bản phát hành hiện thời trong khi nhập khẩu.
  6. Xuất bản thông qua các chính quyền và giữ báo cáo di cư, phát hành ID và điểm quay lại với nhau.
Hướng dẫn mở rộng · Kiến trúc

Hợp đồng mở rộng, không phải mẫu

Một phần mở rộng an toàn đăng ký một kiểu thành phần ổn định và giản đồ, tuyên bố quyền hạn và nhu cầu dữ liệu, thực hiện thông qua trình biên dịch chính thống, và cung cấp các thiết bị xác định cố định / kiểm tra. Đừng yêu cầu bảng tùy ý, hãy tiêm JavaScript vào cổng công cộng, tạo ra một bài báo khác, hoặc đi qua cổng thả.

Tài liệu cổng v2

Trang chứa các nút ổn định, khe cắm, tính chất, tổ hợp, bảng điều khiển đáp ứng, điều kiện và siêu dữ liệu có thể truy cập.

Bộ ghi lưu thành phần

Một hợp đồng cung cấp thông tin về studio, biên dịch viên, tài liệu, di cư và kiểm tra thành thục.

Bộ ghi chép mã nguồn dữ liệu

Cho phép, chỉ đọc, kính hiển vi quyền thay thế tùy ý SQL hoặc hành động năng động.

Một trình vẽ

Xem xét và công cộng chia sẻ kết quả, làm sạch, ngân sách và các bang thời gian chạy.

Hợp đồng thành phần nhà phát triển # 2

Xác định gói thành phần

Dùng một phiên bản nhận diện không tên chữ thường và ngữ pháp. Cung cấp cả hai tên tài sản tương thích nhau hiển thị vì việc kiểm tra gói thanh tra và xác thực bảo mật thực hiện kiểm tra độc lập.

{
  "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}
}

Hình nút

{
  "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"}
}
  • ID vẫn ổn định qua các chỉnh sửa và di cư.
  • Tài sản từ chối những cánh đồng chưa được công bố và không an toàn HTML.
  • Mỗi ô xem có kết nối dữ liệu định nghĩa việc tải, trống, cho phép và đầu ra lỗi sử dụng lại được.
  • Những thành phần ngăn cản đặt tên cho khe của chúng; lá cây không thể chấp nhận sự tùy ý của trẻ em.
  • Thành thật mà nói: lên kế hoạch các khối, thử nghiệm beta cảnh báo, GA đòi hỏi bằng chứng đầy đủ.
Nguồn gốc và tổ hợp dữ liệu

Dùng DTO bảo vệ quyền hạn

  1. Chọn một ID chấm có sẵn như tickets.mine, knowledge.featured hay customer.profile.
  2. Chỉ có các trường được đóng gói được công bố bởi phiên bản DTO. Nguồn không rõ ràng thất bại với data_source.unknown.
  3. Chuyển giao ngữ cảnh cổng đã được cho phép; không bao giờ chấp nhận không gian làm việc/ khách hàng từ một tài sản không đáng tin cậy.
  4. Giới hạn danh sách được kẹp vào1–100..bình thường hoá việc tạo tác, địa phương và tìm kiếm giá trị.
  5. Nếu một nguồn mới không thể tránh, hãy thêm định nghĩa ổn định của nó, bản đồ an toàn, quyền hạn, hành vi trống rỗng và xem thử cùng nhau.
{
  "success": true,
  "source": "tickets.mine",
  "contract_version": 1,
  "items": [
    {"id": 42, "number": "REQ-42", "subject": "Example", "status": "open"}
  ]
}
Nguồn dữ liệu chỉ được đọc. Những sự kiện này cần một hành động dịch vụ có thẩm quyền rõ ràng, sự kết hợp không gian làm việc, sự ký kết hoặc xác nhận quyền hạn, tính năng ưu tiên khi cần thiết và một phong bì lỗi đánh máy.
Nhà phát triển_ tin nhắn

Hãy ở trong ranh giới lòng tin

Biên giớiHành vi cần thiết
Miền làm việcGiải quyết từ máy tin cậy/route/ sssion, sau đó kiểm tra mọi đọc và viết trước khi thực hiện.
HTMLSử dụng danh sách cho phép sử dụng bộ vệ tinh cổng. Không bao giờ phân loại các thuộc tính không đáng tin cậy, URLs, CSS hoặc kịch bản.
Xem thửCần thiết cửa sổ mã nguồn tương tự, phiên bản kênh đã ký và danh sách các thay đổi. Bỏ qua những tin nhắn không được yêu cầu.
Nhận diệnGiữ bí mật bên ngoài giấy tờ. SCIM được tự động thực hiện, không có thời gian và công việc.
GóiTừ chối giao diện, đường dẫn tuyệt đối, tập tin liên kết/ đặc biệt, quá cỡ kho lưu trữ, kiểm trasum/ HTML đang trùng nhau và quyền hạn không rõ.
LỗiMã ổn định, tin nhắn an toàn, khả năng thử lại, chữa trị và mã nhận diện tương quan; đăng nhập ngoại lệ riêng bên máy chủ.
Hiểu biếtĐọc qua helpCenterBridge. Không bao giờ tạo tác giả hoặc sao chép các bài giúp đỡ Trung tâm mở rộng.
{
  "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"}
  }
}
Nhà phát triển phần mềm · và di trú

Kiểm tra, cài đặt và nâng cấp nguyên tử

  1. Bỏ component.json ở ZIP root và giữ mọi con đường tương đối.
  2. Chạy kiểm tra trước. 500 Mục nhập và 25 MB chiết xuất; hợp đồng bảo mật tăng thêm giới hạn độc lập.
  3. Kiểm tra phần chia mong đợi...256 và ký hiệu gói trong tiến trình giải thoát.
  4. Cài đặt vào thư mục đã phiên bản. Không bao giờ thay đổi một phiên bản đã cài đặt.
  5. Cung cấp các cuộc di cư bất động sản để phá vỡ các thay đổi giản đồ và bảo tồn các trường tương thích không rõ ràng.
  6. Mở thành phần trong bản nháp, chạy mọi bang/xem ảnh/người dùng sửa chữa và xuất bản thông qua chính quyền.
  7. Rollback kích hoạt thành phần không thay đổi trước; giữ lại bằng chứng về tính khả thi của nó.
Nhà phát triển # Thử và thả

Chứng minh phần mở rộng cùng một phát hành hah

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

Các cổng nguồn là cần thiết, không đủ. Cơ sở dữ liệu đính kèm/ di chuyển, lông mày thật, bộ phát hành nhân dạng, xác nhận sự tùy ý, khả năng truy cập, hiệu suất, hàng đợi/cron, thư/tatch, sao lưu/ di động và triển khai bằng chứng cho cùng một bản phát hành bất ngờ đã được phát hành. Bằng chứng không rõ ràng phải thất bại khi được thả.

  • Đơn vị: Sche, vệ sinh hóa, hình dạng DTO, điều kiện, di cư và đánh máy thất bại.
  • Hợp đồng: nạp/unty/back/sucitions, trưởng thành, khe, ràng buộc và tính một-render.
  • Trình duyệt: bàn phím, tiêu điểm, ngữ nghĩa, RTL, thu nhỏ/t đổ, giảm chuyển động và mỗi điểm ngắt.
  • Bảo mật: thăm dò không gian làm việc, hành động giả mạo, tấn công gói hàng, xem thử giả mạo và rò rỉ bí mật.
  • Thao tác: tiến trình bền bỉ, quay trái/ trở lại, dừng/rery/resume, tim và cuộn ngược thời gian.
Quản trị + Nhà phát triển + Phục hồi

Sửa lỗi theo trạng thái và ID tương quan

Tình trạngLàm sao đây?
Quyền hạnYêu cầu được đặt tên là "Tiềm năng" (UI) là một tiện lợi bí mật; hậu phương luôn thực thi nó.
Kiểm tra & liên kếtMở trang/tode/field báo cáo, sửa nó, rồi chạy lại trước khi bay.
Xung độtNạp lại bản sửa đổi mới nhất, so sánh các thay đổi và kết quả một cách có chủ đích. Không bao giờ ép buộc ghi đè lên.
Trên mạngGiữ bản nháp, phục hồi kết nối, thử lại thông qua hành động và xác nhận tình trạng công việc bền vững.
Có/ thương tích / không sẵn sàngChép mã nhận diện tương quan và nhãn thời gian để hỗ trợ. Không bao giờ dán các bí mật hoặc văn bản ngoại lệ riêng.
Xuất bản thất bạiXem xét kết xuất/ công việc trước, thử lại chỉ giai đoạn có thể thử lại, hoặc cuộn trở lại để giải phóng lành mạnh cuối cùng.
SCIM 401/403Kiểm tra điểm cuối/khoảng làm việc, mã mang, trạng thái được kích hoạt và quay; không bao giờ sử dụng cookie phiên duyệt.
Kiến thức đã cũ kỹ rồi.Kiểm tra địa phương/ công chúng ở Trung tâm Trợ giúp, rồi kiểm tra bộ nhớ tạm và tuyến đường sạch sẽ.

Hướng dẫn này đã sẵn sàng in. Dùng In → Lưu dạng PDF để sao chép ngoài mạng.