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

Hướng dẫn về quy tắc này được soạn thảo để 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 về quy tắc này dựa trên nguyên tắc viết trong Material Design của Google. Nói một cách đơn giản, đó là:

• Hãy ngắn gọn
• Viết đơn giản và trực tiếp
• Thông báo rõ ràng cho người dùng
• Thông báo các chi tiết quan trọng
• Viết cho mọi cấp độ đọc
• Con người: viết cho con người chứ không phải rô-bốt

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

Thông tin

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

Tên

Tên mẫu được trình bày cho người dùng Trình quản lý thẻ trong toàn bộ giao diện người dùng Trình quản lý thẻ và Thư viện mẫu cho cộng đồng. Nó 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 của bạn và tên chức năng của mẫu: Tên mẫu Tên mẫu.
• Sử dụng viết hoa chữ cái đầu tiên.
• Sử dụng các thuật ngữ mô tả chức năng.
• Tránh sử dụng cụm từ "Chính thức" trong tên mẫu, trừ khi được tổ chức có liên quan cho phép.

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

Mô tả

Mẫu mô tả là bản 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õ cách mẫu của bạn mang lại lợi ích cho người dùng. Ví dụ: "Mẫu Trình tạo đối tượng trên 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 dùng biệt ngữ.
• Bao gồm các đường liên kết để xem thêm thông tin, tài liệu và nội dung hỗ trợ.

Biểu tượng

Biểu tượng mẫu của bạn đượ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.

• Hãy sử dụng tệp PNG, JPEG hoặc GIF cho định dạng hình ảnh.
• Hình ảnh phải là hình vuông, tối thiểu 48px x 48px và không lớn hơn 96px x 96px.
• Kích thước tệp phải nhỏ hơn 50 kilobyte.
• Tránh sử dụng biểu tượng chính thức của công ty, trừ khi bạn được tổ chức có liên quan uỷ quyền làm như vậy.
• Các 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.

Các trường

Các nguyên tắc định 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 khi nó xuất hiện trong Trình chỉnh sửa mẫu chứ không phải như tên người dùng nhìn thấy. Tên phải mang tính mô tả về loại dữ liệu được sử dụng. Định dạng tên thông số là lowerCamelCase. Ví dụ: userName, CustomerID, ShoppingCartValue.

Nhãn trường

Nhãn trường bao gồm 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 thông tin xuất hiện 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. Hãy cung cấp ví dụ (nếu có thể) và mô tả cách trường mẫu được sử dụng hoặc tác động 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.
• Hãy ngắn gọn nhưng phải thân thiện. Bạn có thể sử dụng từ rút gọn và viết ở ngôi thứ hai (bạn).
• Các loại trường được hỗ trợ
• Đượ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 bằng văn bản	Nhập bằng văn bản. Giá trị của loại thông số mẫu 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 được hiển thị trong giao diện người dùng Trình quản lý thẻ có thể là trường văn bản một dòng hoặc đầu vào nhiều dòng.
Trình đơn thả xuống	Trình đơn thả xuống chỉ có thể chọn một mục làm giá trị của thông số mẫu. Liệt kê các mục theo thứ tự bảng chữ cái trừ khi có lý do chính đáng để làm khác.
Checkbox	Nhập hộp đánh dấu. Giá trị của thông số mẫu thuộc loại này sẽ là boolean: true cho đã kiểm tra, false nếu không chọn.
Nút chọn	Đầu vào vô tuyến. Loại thông số mẫu này cung cấp danh sách lựa chọn trong giao diện người dùng Trình quản lý thẻ và người dùng chỉ được phép chọn một trong các lựa chọn làm giá trị của thông số mẫu.
Bảng đơn giản	Nội dung nhập đơn giản vào bảng. Bạn có thể chỉnh sửa từng ô trong bảng và mỗi ô chỉ có thể có hai loại: giá trị nhập bằng văn bản hoặc trình đơn thả xuống. Giá trị của thông số mẫu thuộc loại này là một mảng các đố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.