คู่มือแนะนำนี้จัดทำขึ้นเพื่อช่วยคุณตัดสินใจเกี่ยวกับวิธีเตรียมเทมเพลตสำหรับแกลเลอรีเทมเพลตชุมชน คู่มือสไตล์นี้อิงตามหลักการเขียนของ 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 ประเภท ได้แก่ อินพุตข้อความหรือเมนูแบบเลื่อนลง ค่าของพารามิเตอร์เทมเพลตประเภทนี้คืออาร์เรย์ของออบเจกต์ โดยออบเจกต์แต่ละรายการจะเข้ารหัสแถว คีย์แต่ละรายการในออบเจกต์ต้องเป็นชื่อคอลัมน์ใดคอลัมน์หนึ่ง และค่าแต่ละค่าในออบเจกต์คือค่าของเซลล์ที่เกี่ยวข้อง |