Hướng dẫn định kiểu giao diện người dùng cho Tiện ích bổ sung của Google Workspace

Tiện ích bổ sung cho Google Workspace phải phù hợp với kiểu và bố cục của ứng dụng lưu trữ mà chúng mở rộng. Chúng nên mở rộng giao diện người dùng một cách tự nhiên bằng cách sử dụng các chế độ điều khiển và hành vi quen thuộc. Các nguyên tắc được trình bày ở đây mô tả cách xử lý văn bản, hình ảnh, chế độ điều khiển và hoạt động xây dựng thương hiệu nhằm thúc đẩy trải nghiệm người dùng chất lượng cao.

Nếu tiện ích bổ sung của bạn mở các trang web riêng biệt là một phần không thể thiếu trong hoạt động của tiện ích bổ sung (chẳng hạn như trang cài đặt cho tiện ích bổ sung), hãy đảm bảo các trang web đó cũng tuân theo những nguyên tắc định kiểu này.

Văn bản và hình ảnh

Phần này cho bạn biết cách sử dụng đúng văn bản và hình ảnh trong tiện ích bổ sung của mình.

Tên tiện ích bổ sung

Bạn phải đặt tên tiện ích bổ sung trong tệp kê khai của dự án và khi bạn định cấu hình tiện ích bổ sung để phát hành. Tên này xuất hiện ở nhiều nơi, chẳng hạn như trang thông tin Google Workspace Marketplace và trong các trình đơn. Khi chọn tên:

  • Sử dụng viết hoa chữ cái đầu tiên.
  • Tránh dùng dấu câu, đặc biệt là dấu ngoặc đơn, trừ phi tên đó là một phần của thương hiệu.
  • Hãy tạo tên ngắn gọn — tốt nhất là tối đa 15 ký tự. Hệ thống có thể tự động cắt bớt tên dài tại trang thông tin trên Google Workspace Marketplace và những nơi khác.
  • Không đưa các từ "Google", "Gmail" hoặc tên sản phẩm khác của Google vào tên tiện ích bổ sung của bạn.
  • Đừng thêm từ "tiện ích bổ sung" vào tên tiện ích bổ sung.
  • Bỏ thông tin phiên bản.

Phong cách viết

Bạn không cần phải viết nhiều. Bạn phải thể hiện rõ ràng hầu hết các thao tác thông qua biểu tượng, bố cục và nhãn ngắn. Nếu bạn thấy một phần tiện ích bổ sung của mình cần giải thích rộng hơn so với các nhãn ngắn, tốt nhất bạn nên tạo một trang web riêng mô tả tiện ích bổ sung của mình và liên kết đến tiện ích đó.

Khi viết văn bản giao diện người dùng:

  • Dùng cách viết hoa đầu câu (đặc biệt đối với các nút, nhãn và thao tác thẻ).
  • Ưu tiên văn bản ngắn, đơn giản không có biệt ngữ hoặc từ viết tắt.

Thao tác chung và thẻ

Nếu bạn sử dụng thao tác chung hoặc thao tác thẻ trong tiện ích bổ sung, thì chúng sẽ xuất hiện dưới dạng các mục trong trình đơn trong thẻ bạn xác định. Bạn có thể chọn văn bản được dùng trong các trình đơn này cho những thao tác này. Khi chọn văn bản để sử dụng:

  • Tránh dùng văn bản trình đơn chỉ lặp lại tên tiện ích bổ sung.
  • Bắt đầu mỗi mục trong trình đơn bằng một từ hành động như "Run", "Configure" (Định cấu hình) hoặc "Create".
  • Mô tả tác vụ, chứ không phải thành phần giao diện người dùng mà thao tác hiển thị.
  • Nếu hành động của bạn bắt đầu một quy trình và không có một động từ nào mô tả công việc đó, hãy gọi đó là "Bắt đầu".
  • Duy trì số lượng mục trong trình đơn nhỏ để tránh buộc người dùng phải cuộn qua một danh sách lớn. Nếu bạn có nhiều thao tác cần triển khai hơn, hãy cân nhắc sử dụng nhiều thẻ với các thao tác khác nhau trên mỗi thẻ.

Thông báo lỗi

Khi gặp sự cố, cần sử dụng ngôn từ thuần tuý. Giải thích vấn đề từ quan điểm của người dùng và đề xuất cách khắc phục.

  • Không cho phép người dùng xem bất kỳ ngoại lệ nào mà mã của bạn gửi. Thay vào đó, hãy sử dụng câu lệnh try...catch để chặn các trường hợp ngoại lệ, sau đó hiển thị thông báo lỗi thân thiện với người dùng.
  • Trước khi phát hành, hãy kiểm tra để đảm bảo tiện ích bổ sung của bạn không hiển thị thông tin gỡ lỗi trong giao diện người dùng.

Nội dung trợ giúp

Bạn nên thiết kế các thẻ cho thấy thông tin trợ giúp hoặc giải thích cách hoạt động của tiện ích bổ sung cho người dùng. Nếu bạn xây dựng nội dung trợ giúp cho tiện ích bổ sung, hãy nhớ:

  • Khi có thể, hãy hiển thị hướng dẫn dưới dạng danh sách có dấu đầu dòng hoặc được đánh số. Hướng dẫn người dùng đến kết quả cuối cùng, với thông tin tham chiếu rõ ràng đến các thành phần trên giao diện người dùng được đặt tên.
  • Hãy đảm bảo hướng dẫn của bạn giải thích rõ mọi yêu cầu, chẳng hạn như thiết lập bảng tính theo một cách nhất định.
  • Bạn có thể liên kết đến nội dung trợ giúp bên ngoài, chẳng hạn như các trang web hỗ trợ.

Hình ảnh

Hình ảnh dùng trong tiện ích bổ sung của bạn là một trong các loại biểu tượng tích hợp sẵn hoặc hình ảnh được lưu trữ công khai do URL chỉ định. Khi sử dụng hình ảnh được lưu trữ, hãy đảm bảo rằng tất cả những người có thể sử dụng tiện ích bổ sung của bạn đều có thể truy cập vào hình ảnh đó.

Các chế độ kiểm soát

Phần này cung cấp các nguyên tắc về trải nghiệm người dùng cho tiện ích tương tác.

Nút

Sử dụng các nút để kiểm soát các thao tác chính trên giao diện người dùng thay vì các tiện ích khác.

  • Hầu hết các nhãn của nút văn bản nên bắt đầu bằng một động từ.
  • Trong hầu hết các trường hợp, chỉ nên có tối đa 3 nút trên các hàng nút.

Văn bản được trang trí

Tiện ích văn bản được trang trí cho phép bạn trình bày nội dung văn bản bằng biểu tượng, nút hoặc công tắc.

  • Chỉ viết hoa đầu câu cho nội dung văn bản.
  • Văn bản của tiện ích Trang tríText sẽ bị cắt ngắn nếu không thể vừa với không gian có sẵn. Vì lý do này, hãy luôn cố gắng giữ nội dung văn bản ngắn nhất có thể.

Thông tin đầu vào để lựa chọn

Bạn có thể sử dụng nhiều tiện ích nhập liệu lựa chọn trong tiện ích bổ sung: hộp chọn thả xuống, hộp đánh dấu và nút chọn.

  • Sử dụng hộp đánh dấu khi mọi người có thể chọn nhiều tuỳ chọn hoặc hoàn toàn không chọn tuỳ chọn nào. Sử dụng nút chọn (hoặc trình đơn chọn) khi phải chọn đúng một tuỳ chọn. Sử dụng trình đơn thả xuống khi cung cấp một danh sách ngắn các phương án thay thế trong khi đang cố gắng tiết kiệm không gian trong giao diện người dùng.
  • Sử dụng cách viết hoa đầu câu cho văn bản được chỉ định cho mỗi tuỳ chọn.
  • Tránh sử dụng các thay đổi về lựa chọn để kích hoạt các hành động quan trọng, khó đảo ngược vì mọi người thường nhầm lẫn khi lựa chọn. Thay vào đó, hãy cân nhắc thêm một nút đọc các giá trị lựa chọn hiện tại rồi kích hoạt hành động.
  • Đối với trình đơn thả xuống, hãy sắp xếp các tuỳ chọn theo thứ tự bảng chữ cái hoặc theo lược đồ logic mà tất cả người dùng đều hiểu được (chẳng hạn như trình bày các ngày trong tuần theo thứ tự, bắt đầu từ Chủ Nhật hoặc thứ Hai).
  • Giới hạn số lượng tuỳ chọn trong một tiện ích nhập liệu lựa chọn nhất định ở một số hợp lý. Nếu có quá nhiều tuỳ chọn, người dùng có thể thấy khó sử dụng tiện ích. Trong những trường hợp đó, hãy cân nhắc chia nhỏ tuỳ chọn thành các danh mục khác nhau và nhiều tiện ích.

Nhập văn bản

Mục nhập văn bản cho phép người dùng nhập dữ liệu chuỗi.

  • Không sử dụng phương thức nhập bằng văn bản khiến người dùng nhập một trong một tập hợp các mục nhập cụ thể có thể nhập. Hãy sử dụng một lựa chọn trong trình đơn thả xuống.
  • Sử dụng các gợi ý và đề xuất để giúp người dùng nhập văn bản có định dạng và nội dung chính xác.
  • Sử dụng phương thức nhập văn bản nhiều dòng nếu văn bản cần nhập có nhiều hơn một vài từ.

Xây dựng thương hiệu

Phần này cung cấp các nguyên tắc về trải nghiệm người dùng để thêm các thành phần thương hiệu vào giao diện tiện ích bổ sung của bạn.

Trong tiện ích bổ sung của bạn

Nếu bạn muốn đưa thương hiệu vào giao diện người dùng của tiện ích bổ sung, hãy viết ngắn gọn và ngắn gọn. Điều này giúp mọi người tập trung vào chức năng của tiện ích bổ sung của bạn.

  • Mọi khía cạnh của tiện ích bổ sung của bạn phải tuân thủ nguyên tắc sử dụng thương hiệu.
  • Đừng thêm từ "Google", "Gmail" hoặc các tên sản phẩm khác của Google.
  • Đừng đưa biểu tượng sản phẩm của Google vào, kể cả khi chúng đã được thay đổi.
  • Đừng đưa từ "tiện ích bổ sung" vào văn bản thương hiệu.
  • Văn bản thương hiệu không nên dài quá vài từ.

Trong Google Workspace Marketplace

Khi định cấu hình tiện ích bổ sung để phát hành, bạn cần cung cấp một số thành phần đồ hoạ và văn bản để tạo trang thông tin trên Google Workspace Marketplace.

Mọi khía cạnh của trang thông tin trên Cửa hàng Play và những thành phần này phải tuân thủ nguyên tắc sử dụng thương hiệu.