คู่มือรูปแบบนี้ได้รับการจัดเตรียมเพื่อช่วยในการตัดสินใจเกี่ยวกับวิธีเตรียมเทมเพลตสําหรับแกลเลอรีเทมเพลตชุมชน คําแนะนํารูปแบบนี้อิงตามหลักการเขียนของ Google Material Design พูดง่ายๆ คือ
- คุณจึงควรใช้ชื่อที่กระชับ
- เขียนได้ตรงประเด็น
- ระบุที่อยู่ของผู้ใช้อย่างชัดเจน
- แจ้งรายละเอียดที่จําเป็น
- เขียนสําหรับทุกระดับการอ่าน
- เป็นมนุษย์: เขียนให้มนุษย์ ไม่ใช่หุ่นยนต์
ปฏิบัติตามหลักเกณฑ์เหล่านี้เพื่อช่วยให้เทมเพลตทั้งหมดมีรูปลักษณ์ที่สอดคล้องกัน และช่วยให้ผู้ใช้เข้าใจวิธีใช้เทมเพลต
ข้อมูล
หลักเกณฑ์เหล่านี้มีผลกับรายการที่พบในแท็บข้อมูลของเครื่องมือแก้ไขเทมเพลต
ชื่อ
ระบบจะแสดงชื่อเทมเพลตต่อผู้ใช้ Tag Manager ในอินเทอร์เฟซผู้ใช้ของ Tag Manager และแกลเลอรีเทมเพลตชุมชน โดยจะปรากฏที่ด้านบนของหน้ารายละเอียดของเทมเพลต และจะปรากฏขึ้นเมื่อมีเทมเพลตแสดงอยู่
- ใช้ชื่อบริษัท/องค์กรและชื่อฟังก์ชันของเทมเพลต: ชื่อองค์กร ชื่อเทมเพลต
- ขึ้นต้นทุกคําด้วยตัวพิมพ์ใหญ่
- ใช้คําที่อธิบายฟังก์ชันการทํางาน
- หลีกเลี่ยงการใช้คําว่า "อย่างเป็นทางการ" ในชื่อเทมเพลต เว้นแต่คุณจะได้รับอนุญาตจากองค์กรที่เกี่ยวข้อง
ตัวอย่าง: แท็กการวัด Conversion ของ MyCompany, ตัวแปรรหัสแคมเปญ MyCompany
คำอธิบาย
คําอธิบายเทมเพลตคือคําอธิบายเทมเพลตที่ปรากฏในหน้ารายละเอียด ซึ่งเป็นข้อมูลสรุปสั้นๆ เกี่ยวกับฟังก์ชันของเทมเพลต
- ใช้ประโยคที่กระชับและชัดเจนในการอธิบายสิ่งที่เทมเพลตทํา
- ระบุอย่างชัดเจนว่าเทมเพลตให้ประโยชน์แก่ผู้ใช้อย่างไร ตัวอย่างเช่น "เทมเพลตเครื่องมือสร้างกลุ่มเป้าหมายของ Example.com จะช่วยคุณสร้างรายการกลุ่มเป้าหมายใหม่จากผู้เข้าชมเว็บไซต์"
- หลีกเลี่ยงการใช้ศัพท์เฉพาะ
- ใส่ลิงก์เพื่อดูข้อมูลเพิ่มเติม เอกสารประกอบ และการสนับสนุน
Icon
ไอคอนเทมเพลตจะแสดงเป็นภาพขนาดย่อเมื่อระบุไว้ใน Tag Manager และในแกลเลอรีเทมเพลตชุมชน
- ใช้ PNG, JPEG หรือ GIF สําหรับรูปแบบรูปภาพ
- รูปภาพควรเป็นสี่เหลี่ยมจัตุรัส อย่างน้อย 48 x 48 พิกเซล และไม่เกิน 96 x 96 พิกเซล
- ไฟล์ต้องมีขนาดไม่เกิน 50 กิโลไบต์
- หลีกเลี่ยงการใช้โลโก้บริษัทอย่างเป็นทางการ เว้นแต่คุณจะได้รับอนุญาตจากองค์กรที่เกี่ยวข้อง
- ช่อง
- ใช้แท็บช่องของเครื่องมือแก้ไขเทมเพลตเพื่อเพิ่มองค์ประกอบแบบฟอร์ม เช่น การป้อนข้อความ ช่องทําเครื่องหมาย ฯลฯ
ช่อง
หลักเกณฑ์รูปแบบเหล่านี้มีผลกับแท็บช่องของเครื่องมือแก้ไขเทมเพลต
ชื่อพารามิเตอร์
นี่คือชื่อช่องตามที่ปรากฏในเครื่องมือแก้ไขเทมเพลต แต่ไม่ใช่ตามที่ปรากฏในผู้ใช้ ชื่อควรอธิบายถึงประเภทของข้อมูลที่ใช้ จัดรูปแบบชื่อพารามิเตอร์เป็น lowerCamelCase ตัวอย่าง: userName, customerID, ShoppingCartValue
ป้ายกํากับช่อง
ป้ายกํากับช่องจะมีช่องชื่อที่แสดง ข้อความช่องทําเครื่องหมาย และรายการที่เกี่ยวข้อง
- ขึ้นต้นประโยคด้วยตัวพิมพ์ใหญ่ หรือใช้ตัวพิมพ์ใหญ่กับอักษรตัวแรกของคําและวิสามานยนาม (สําหรับภาษาอังกฤษ)
- ยิ่งสั้นยิ่งดี
- สื่อความหมาย
- ใช้คําทั่วไป
ข้อความช่วยเหลือ
ข้อความช่วยเหลือคือเนื้อหาที่ให้ข้อมูลซึ่งแสดงเป็นเคล็ดลับเครื่องมือเพื่อช่วยให้ผู้ใช้ป้อนค่าที่ถูกต้องในช่องเทมเพลต หากเป็นไปได้ ป้อนอินพุตตัวอย่าง และอธิบายวิธีที่ใช้ช่องเทมเพลตหรือผลกระทบของการระบุค่าบางค่า
- ขึ้นต้นประโยคด้วยตัวพิมพ์ใหญ่ หรือใช้ตัวพิมพ์ใหญ่กับอักษรตัวแรกของคําและวิสามานยนาม (สําหรับภาษาอังกฤษ)
- คุณจึงควรใช้ชื่อที่กระชับแต่ควรเป็นมนุษย์ สามารถใช้การย่อและเขียนในรูปที่ 2 (คุณ)
- ประเภทช่องที่รองรับ
- อนุญาตให้ใช้การจัดรูปแบบ HTML พื้นฐาน ตัวอย่าง:
<strong>,<em>
ประเภทช่องที่รองรับ
ประเภท |
คำอธิบาย |
|---|---|
| การป้อนข้อความ | การป้อนข้อความ ค่าพารามิเตอร์ของพารามิเตอร์ประเภทนี้จะเป็นสตริงที่อาจอ้างอิงถึงตัวแปร วิดเจ็ตอินพุตข้อความที่แสดงในอินเทอร์เฟซผู้ใช้ของ Tag Manager อาจเป็นช่องข้อความบรรทัดเดียวหรืออินพุตหลายบรรทัดก็ได้ |
| เมนูแบบเลื่อนลง | เมนูแบบเลื่อนลงที่สามารถเลือกได้เพียงรายการเดียวเป็นค่าของพารามิเตอร์เทมเพลต ระบุรายการตามลําดับตัวอักษร เว้นแต่จะมีเหตุผลสมควร |
| ช่องทําเครื่องหมาย | อินพุตของช่องทําเครื่องหมาย ค่าพารามิเตอร์ของพารามิเตอร์ประเภทนี้จะเป็นบูลีน จริง: ตรวจสอบแล้ว เท็จ ยกเลิกการเลือกแล้ว |
| ปุ่มตัวเลือก | อินพุตวิทยุ พารามิเตอร์เทมเพลตประเภทนี้จะแสดงรายการตัวเลือกในอินเทอร์เฟซผู้ใช้ของ Tag Manager และผู้ใช้จะเลือกตัวเลือกใดตัวเลือกหนึ่งเป็นค่าของพารามิเตอร์เทมเพลตได้ |
| ตารางแบบง่าย | อินพุตตารางแบบง่าย เซลล์แต่ละเซลล์ในตารางจะแก้ไขได้ โดยแต่ละเซลล์ต้องมีเพียง 2 ประเภท ได้แก่ อินพุตข้อความหรือเมนูแบบเลื่อนลง ค่าพารามิเตอร์ของพารามิเตอร์ประเภทนี้คืออาร์เรย์ของออบเจ็กต์ โดยแต่ละรายการจะเข้ารหัสแถว แต่ละคีย์ในออบเจ็กต์ต้องเป็นชื่อคอลัมน์ และแต่ละค่าในออบเจ็กต์คือค่าของเซลล์ที่เกี่ยวข้อง |