UI Style Guide
출처: 문서
본문
UI 스타일 가이드
이 가이드는 OpenSearch Dashboards UI 텍스트 기여자를 위한 작성 기준을 제공해요. 일반적인 브랜드 아이덴티티, 명명 규칙 및 문서 서식 규칙은 스타일 가이드를 참조하세요.
UI 모범 사례
- OpenSearch Project의 명명 규칙, 음성 및 톤, 브랜드 개성 특성 지침을 따르세요.
- 페이지 및 사이트의 다른 요소와 일관성을 유지하세요.
- 제품명 및 기타 고유 명사를 제외하고 UI에서는 문장형 대소문자를 사용하세요.
UI 음성 및 톤
UI 텍스트는 모든 OpenSearch 콘텐츠와 동일한 음성 및 톤 원칙을 따라요. 자세한 내용은 음성 및 톤 및 브랜드 개성 특성을 참조하세요.
작성 지침
UI 텍스트는 사용자 인터페이스의 중요한 구성 요소예요. 개념을 설명하고 논리적인 흐름을 따르는 간단한 지침을 제공하여 사용자가 작업을 완료할 수 있도록 도와요. 일관되고 간결하며 명확한 언어를 사용하기 위해 노력해요.
UI 텍스트의 목적은 무엇인가요?
UI 텍스트는 화면의 모든 단어, 구문 및 문장을 포함하며 다음과 같은 목적이 있어요:
- 개념을 설명하거나 용어를 정의해요.
- 작업 완료 방법을 설명해요.
- 페이지, 섹션, 표, 그래프 또는 대화 상자의 목적을 설명해요.
- 튜토리얼 및 첫 실행 경험을 안내해요.
- 사용자에게 익숙하지 않을 수 있는 개별 UI 요소에 대한 컨텍스트와 설명을 제공해요.
- 사용자가 특정 배포 시나리오 또는 환경에 설정이 관련이 있거나 필요한지 선택하거나 결정하는 데 도움을 줘요.
- 알림 또는 오류를 설명해요.
기본 지침
UI 텍스트를 작성할 때 다음 기본 지침을 따르세요.
스타일
- 간결하게 유지하세요. 사용자는 빽빽한 텍스트를 읽고 싶어하지 않아요. UI 텍스트는 다른 언어로 번역될 때 30%까지 늘어날 수 있음을 기억하세요.
- 단순하게 유지하세요. 복문이나 중문보다는 단문(하나의 주어, 하나의 동사, 하나의 주절과 아이디어)을 사용하도록 노력하세요.
- 수동태보다 능동태를 선호하세요. 예를 들어, "You can attach up to 10 policies"는 능동태이고 "Up to 10 policies can be attached"는 수동태예요.
- 마우스 특정 언어보다는 장치에 구애받지 않는 언어를 사용하세요. 예를 들어, click 대신 _choose_를 사용하세요 (예외: 체크박스에는 select, 체크박스 선택 해제에는 _clear_를 사용하세요).
톤
- 대부분의 사용자가 이해할 수 있는 일상적인 언어를 사용하세요.
- 사용자에게 말할 때는 2인칭(you, your)을 사용하세요.
- 조직으로서 OpenSearch Project를 언급해야 하는 경우 _we_를 사용하세요. 예를 들어, "We recommend…."
세부 규칙
-
모든 UI 텍스트에는 문장형 대소문자를 사용하세요. (문장이나 구의 첫 단어와 서비스 이름과 같은 고유 명사만 대문자로 표기해요. 다른 모든 단어는 소문자로 표기해요.)
-
병렬 구조를 사용하세요 (문법적으로 유사한 구와 문장을 사용해요). 예를 들어, 목록의 항목은 모두 동사로 시작하거나 모두 명사로 시작해야 해요.
올바른 예:
스냅샷에는 두 가지 주요 용도가 있어요:
- 장애로부터 복구
- 한 클러스터에서 다른 클러스터로 마이그레이션
잘못된 예:
스냅샷에는 두 가지 주요 용도가 있어요:
- 장애 복구
- 한 클러스터에서 다른 클러스터로 마이그레이션
-
연쇄(옥스포드) 쉼표를 사용하세요. 예를 들어, "issues, bug fixes, and features"와 같이 사용하고 "issues, bug fixes and features"와 같이 사용하지 마세요.
-
UI 레이블이나 제목에서 "and"를 대체하여 앰퍼샌드(&)를 사용하지 마세요. 이는 코드, URL 또는
&가 구문상 필요한 쿼리 매개변수에는 적용되지 않아요. -
e.g., i.e., _etc._와 같은 라틴어 표현을 피하세요. e.g. 대신 for example 또는 _such as_를 사용하세요. i.e. 대신 that is 또는 _specifically_를 사용하세요. 일반적으로 etc. 및 그에 상응하는 표현(예: and more 또는 and so on)은 필요하지 않아요.