이 스타일 가이드는 커뮤니티 템플릿 갤러리용 템플릿을 준비하는 방법을 결정하는 데 도움을 주기 위해 작성되었습니다. 이 스타일 가이드는 Google Material Design 작성 원칙을 바탕으로 합니다. 간단히 설명하면 다음과 같습니다.
- 간결하게 작성합니다.
- 단순하고 직접적으로 작성합니다.
- 사용자에게 명확하게 알립니다.
- 핵심적인 세부정보를 전달합니다.
- 모든 수준의 독자를 위해 작성합니다.
- 로봇이 아닌 사람을 위해 작성합니다.
다음 가이드라인에 따라 모든 템플릿의 디자인이 일관되고 사용자가 템플릿 사용 방법을 이해할 수 있도록 해주세요.
정보
이 가이드라인은 템플릿 편집기의 정보 탭에 있는 항목에 적용됩니다.
이름
템플릿 이름은 태그 관리자 사용자 인터페이스와 커뮤니티 템플릿 갤러리를 통해 태그 관리자 사용자에게 표시됩니다. 템플릿이 표시될 때 템플릿의 세부정보 페이지 상단에 표시됩니다.
- 회사/조직 이름과 템플릿의 기능상 이름(조직 이름 템플릿 이름)을 사용합니다.
- 단어 첫 글자를 대문자로 표시합니다.
- 기능을 설명하는 용어를 사용합니다.
- 관련 조직의 허가를 받지 않은 경우 템플릿 이름에 '공식'이라는 용어를 사용하지 않습니다.
예: MyCompany 전환 측정 태그, MyCompany 캠페인 ID 변수
설명
템플릿 설명은 세부정보 페이지에 템플릿 기능의 간략한 요약으로 표시되는 템플릿의 설명입니다.
- 명확하고 간결한 문장을 사용하여 템플릿의 기능을 설명합니다.
- 템플릿이 사용자에게 주는 혜택을 명확하게 설명합니다. 예: "Example.com 잠재고객 생성 도구 템플릿을 사용하면 웹사이트 방문자로부터 새로운 잠재고객 목록을 만들 수 있습니다."
- 전문 용어는 피합니다.
- 추가 정보, 설명서, 지원에 대한 링크를 포함합니다.
아이콘
템플릿 아이콘은 태그 관리자 및 커뮤니티 템플릿 갤러리에 썸네일로 표시됩니다.
- PNG, JPEG 또는 GIF 이미지 형식을 사용합니다.
- 이미지는 정사각형으로 48x48픽셀 이상, 96x96픽셀 이하여야 합니다.
- 파일 크기는 50KB 미만이어야 합니다.
- 관련 조직의 허가를 받지 않은 경우 회사의 공식 로고를 사용하지 않습니다.
- 필드
- 템플릿 편집기의 필드 탭을 사용하여 텍스트 입력, 체크박스와 같은 양식 요소를 추가합니다.
필드
이 스타일 가이드라인은 템플릿 편집기의 필드 탭에 적용됩니다.
매개변수 이름
템플릿 편집기에 표시되나 사용자에게는 표시되지 않는 필드 이름입니다. 사용되는 데이터의 유형을 설명하는 이름이어야 합니다. 매개변수 이름의 형식을 lowerCamelCase
로 지정하세요. 예: userName, customerID, shoppingCartValue
필드 라벨
필드 라벨에는 표시 이름 필드, 체크박스 텍스트, 관련 항목이 포함됩니다.
- 첫 글자는 대문자로 표기합니다.
- 짧을수록 효과적입니다.
- 자세히 설명합니다.
- 일반적인 단어를 사용합니다.
도움말 텍스트
도움말 텍스트는 사용자가 템플릿 필드에 유효한 값을 입력하는 데 도움이 되는 정보를 제공하는 콘텐츠입니다. 가능한 경우 예시 입력을 제공하고 템플릿 필드가 사용되는 방식 또는 특정 값을 제공하는 경우의 효과를 설명하세요.
- 첫 글자는 대문자로 표기합니다.
- 간결하면서도 이해하기 쉽도록 작성합니다. 축약형을 사용하고 독자를 2인칭으로 작성하는 것은 허용됩니다.
- 지원되는 필드 유형
- 기본 HTML 형식은 허용됩니다. 예:
<strong>
,<em>
.
지원되는 필드 유형
유형 |
설명 |
---|---|
텍스트 입력 | 텍스트 입력. 이 유형의 템플릿 매개변수 값은 변수를 참조할 수 있는 문자열입니다. 태그 관리자 사용자 인터페이스에 렌더링되는 텍스트 입력 위젯은 한 줄 텍스트 필드 또는 여러 줄 입력입니다. |
드롭다운 메뉴 | 단일 항목만 템플릿 매개변수 값으로 선택할 수 있는 드롭다운 메뉴입니다. 특별한 이유가 없는 한 항목을 알파벳순으로 표시하세요. |
체크박스 | 체크박스 입력. 이 유형의 템플릿 매개변수 값은 불리언입니다. 선택된 경우 true, 선택 해제된 경우 false입니다. |
라디오 버튼 | 라디오 입력. 이 유형의 템플릿 매개변수는 태그 관리자 사용자 인터페이스에 선택 사항의 목록을 제공하며 사용자는 선택 항목 중 하나만 템플릿 매개변수의 값으로 선택할 수 있습니다. |
단순 표 | 단순 표 입력. 표의 각 셀은 그 자리에서 수정할 수 있으며 텍스트 입력 또는 드롭다운 메뉴의 두 유형만 될 수 있습니다. 이 유형의 템플릿 매개변수 값은 객체의 배열입니다. 각 객체는 하나의 행을 인코딩하고, 객체의 각 키는 열 이름 중 하나여야 하며, 객체의 각 값은 해당 셀의 값입니다. |