Hướng dẫn về kiểu mẫu

Hướng dẫn tạo kiểu này được chuẩn bị để giúp bạn đưa ra quyết định về cách chuẩn bị mẫu cho Thư viện mẫu cho cộng đồng. Hướng dẫn quy tắc này dựa trên các nguyên tắc viết của Google Material Design. Nói một cách đơn giản, đó là:

  • Ngắn gọn
  • Viết đơn giản và trực tiếp
  • Trình bày rõ ràng với người dùng
  • Thông báo các chi tiết cần thiết
  • Viết cho mọi cấp độ đọc
  • Hãy viết cho con người, chứ không phải cho robot

Hãy làm theo các nguyên tắc này để đảm bảo rằng tất cả mẫu đều có giao diện nhất quán và giúp người dùng hiểu cách sử dụng mẫu của bạn.

Thông tin

Những nguyên tắc này áp dụng cho các mục có trong thẻ Thông tin của Trình chỉnh sửa mẫu.

Tên

Tên mẫu được hiển thị cho người dùng Trình quản lý thẻ trong toàn bộ giao diện người dùng của Trình quản lý thẻ và Thư viện mẫu cho cộng đồng. Thông tin này xuất hiện ở đầu trang chi tiết của mẫu và xuất hiện khi các mẫu được liệt kê.

  • Sử dụng tên công ty/tổ chức và tên chức năng của mẫu: Tên tổ chức Tên mẫu.
  • Sử dụng cách viết hoa chữ cái đầu.
  • Sử dụng các thuật ngữ mô tả chức năng.
  • Tránh sử dụng từ "Chính thức" trong tên mẫu, trừ phi bạn được tổ chức có liên quan uỷ quyền.

Ví dụ: Thẻ đo lường lượt chuyển đổi MyCompany, Biến mã chiến dịch MyCompany

Mô tả

Nội dung mô tả mẫu là nội dung mô tả mẫu xuất hiện trên trang chi tiết dưới dạng bản tóm tắt ngắn gọn về chức năng của mẫu.

  • Sử dụng các câu rõ ràng và súc tích để mô tả chức năng của mẫu.
  • Nêu rõ lợi ích của mẫu đối với người dùng. Ví dụ: "Mẫu Trình tạo đối tượng Example.com có thể giúp bạn tạo danh sách đối tượng mới từ khách truy cập trang web".
  • Tránh sử dụng từ chuyên môn.
  • Cung cấp đường liên kết đến thông tin bổ sung, tài liệu và dịch vụ hỗ trợ.

Biểu tượng

Biểu tượng mẫu được thể hiện dưới dạng hình thu nhỏ khi được liệt kê trong Trình quản lý thẻ và trên Thư viện mẫu cho cộng đồng.

  • Sử dụng định dạng hình ảnh PNG, JPEG hoặc GIF.
  • Hình ảnh phải là hình vuông, có kích thước tối thiểu là 48 pixel x 48 pixel và không lớn hơn 96 pixel x 96 pixel.
  • Kích thước tệp phải nhỏ hơn 50 kilobyte.
  • Tránh sử dụng biểu trưng chính thức của công ty, trừ phi bạn được tổ chức có liên quan cho phép.
  • Trường
  • Sử dụng thẻ Trường của Trình chỉnh sửa mẫu để thêm các thành phần biểu mẫu như mục nhập văn bản, hộp đánh dấu, v.v.

Trường

Những nguyên tắc về kiểu này áp dụng cho thẻ Trường của Trình chỉnh sửa mẫu.

Tên thông số

Đây là tên của trường xuất hiện trong Trình chỉnh sửa mẫu, nhưng không phải là tên xuất hiện trước người dùng. Tên phải mô tả loại dữ liệu được sử dụng. Định dạng tên tham số là lowerCamelCase. Ví dụ: userName, customerID, shoppingCartValue.

Nhãn trường

Nhãn trường bao gồm các trường tên hiển thị, văn bản hộp đánh dấu và các mục có liên quan.

  • Sử dụng cách viết hoa đầu câu.
  • Càng ngắn càng tốt.
  • Hãy cung cấp thông tin mô tả.
  • Sử dụng các từ phổ biến.

Văn bản trợ giúp

Văn bản trợ giúp là nội dung cung cấp thông tin, hiển thị dưới dạng chú giải công cụ, để giúp người dùng nhập giá trị hợp lệ vào trường mẫu. Cung cấp ví dụ về dữ liệu đầu vào (nếu có) và mô tả cách sử dụng trường mẫu hoặc hiệu quả của việc cung cấp một số giá trị nhất định.

  • Sử dụng cách viết hoa đầu câu.
  • Ngắn gọn nhưng vẫn mang tính nhân văn. Bạn có thể sử dụng từ viết tắt và viết ở ngôi thứ hai (bạn).
  • Các loại trường được hỗ trợ
  • Bạn được phép định dạng HTML cơ bản. Ví dụ: <strong>, <em>.

Các loại trường được hỗ trợ

Loại
 Mô tả
Nhập văn bản Nhập văn bản. Giá trị của tham số mẫu thuộc loại này sẽ là một chuỗi có thể tham chiếu đến các biến. Tiện ích nhập văn bản hiển thị trong giao diện người dùng của Trình quản lý thẻ có thể là trường văn bản một dòng hoặc nhập nhiều dòng.
Trình đơn thả xuống Trình đơn thả xuống chỉ cho phép chọn một mục duy nhất làm giá trị của tham số mẫu. Liệt kê các mục theo thứ tự bảng chữ cái, trừ phi có lý do chính đáng.
Checkbox Nhập bằng hộp đánh dấu. Giá trị của thông số mẫu thuộc loại này sẽ là boolean: true (đã đánh dấu) đối với trường hợp đã đánh dấu và false (chưa đánh dấu) đối với trường hợp chưa đánh dấu.
Nút chọn Phương thức nhập dữ liệu dạng danh sách. Tham số mẫu thuộc loại này hiển thị danh sách các lựa chọn trong giao diện người dùng của Trình quản lý thẻ và người dùng chỉ được chọn một trong các lựa chọn đó làm giá trị của tham số mẫu.
Bảng đơn giản Dữ liệu đầu vào dạng bảng đơn giản. Bạn có thể chỉnh sửa tại chỗ từng ô trong bảng và mỗi ô chỉ có thể thuộc một trong hai loại: mục nhập văn bản hoặc trình đơn thả xuống. Giá trị của tham số mẫu thuộc loại này là một mảng đối tượng: mỗi đối tượng mã hoá một hàng, mỗi khoá trong đối tượng phải là một trong các tên cột và mỗi giá trị trong đối tượng là giá trị của ô tương ứng.