대문자 표기

대문자 표기 (Capitalization)

일관된 대문자 표기는 제품 UI 전체에 명확성과 통일성을 더해요. PatternFly는 모든 제목, 소제목, 부제에서 sentence case(문장형 대문자)를 권장해요. 언제 어떻게 대문자를 쓰는지 이 문서에서 정리해 드릴게요.

출처: 문서

본문

대문자 표기 지침 (Capitalization guidelines)

일관된 대문자 표기는 명확성을 더하고 제품 UI 전체에 통일성을 만들어 줘요. PatternFly는 모든 제목, 헤딩, 부제, 소제목에 sentence case로 쓰기를 권장합니다. sentence case는 첫 단어의 첫 글자만 대문자로 해요. 유일한 예외는 고유명사, 제품명, 두문자어(acronyms), 이니셜리즘(initialisms)으로, 이들은 모두 대문자를 써야 해요.

예를 들어: "When you use PatternFly's design resources, you get helpful tips and best practices."

무엇보다도 가장 중요한 목표는 일관성이에요. 무엇을 설계하느냐에 따라 다른 대문자 표기 기준을 사용해야 할 수도 있지만, 제품 영역 안에서 대문자 표기를 일관되게 유지해야 해요.

Red Hat 제품 UI (Red Hat product UIs)

제품을 위해 쓸 때는 다음 대문자 표기 패턴을 따르세요.

  • 내비게이션 항목, 페이지 제목, 버튼 등 모든 UI 요소에 기본적으로 sentence case를 사용하세요.

  • 커스텀 리소스의 대문자 표기는 생성 당시 사용된 대문자 표기 방식과 동일하게 유지하세요.

  • 예를 들어 커스텀 리소스 이름이 모두 소문자로 만들어졌다면, 이 리소스를 언급할 때 어떤 글자도 대문자로 바꾸지 마세요.

  • 제품 기능 이름이 고유명사로 쓰이거나 대문자 UI 용어(예: 내비게이션 항목)를 가리킬 때는 대문자로 쓰세요. 일반적인 개념을 설명할 때는 소문자로 쓰세요. 예를 들어:

기능 이름 (Feature name) UI 텍스트 이유 (Reasoning)
Compliance "Check your system compliance using Red Hat Insights Compliance." 첫 번째 "compliance"는 개념을 가리키므로 소문자예요. 두 번째 "compliance"는 cloud.redhat.com에서 제공되는 특정 기능을 가리키므로 대문자예요.
Sources "Add a source by going to Settings > Sources." "Check the Sources table for status." 버튼 텍스트: "Add source" "Sources"는 UI의 하위 섹션, 기능 또는 위치를 직접 가리킬 때만 대문자로 써요. "Source"는 버튼 라벨이 항상 sentence case여야 하므로 버튼 텍스트에서는 소문자예요.
  • "Technical API references"에 설명된 대로 API 리소스의 대문자 표기를 맞추세요.

브레드크럼 경로에서의 대문자 표기 (Capitalization in breadcrumb trails)

페이지 제목이 브레드크럼 경로에서 항목으로 나타나는 것은 흔한 일이에요. 대응하는 브레드크럼 항목에서 원래 페이지 제목의 대문자 표기를 그대로 맞추세요. 항목이 sentence case가 아니거나, 브레드크럼 경로에 대문자 표기 기준이 섞여 있어도 마찬가지예요.

때때로 사용자가 이름을 붙인 항목이 브레드크럼 경로에 나타날 수 있어요. "customResource-name" 같은 커스텀 리소스 이름이 브레드크럼 경로에 포함되어 있다면, 사용자의 원래 입력 대문자 표기를 그대로 맞춰야 해요.

API 및 코드 참조 대문자 표기 (API and code reference capitalization)

기술 리소스와 API 객체에 대해 쓸 때, 올바른 대문자 표기와 형식은 개념에 대해 일반적으로 말하는지 특정 API 리소스를 참조하는지에 따라 달라져요.

일반 참조 (sentence case) (General references)

UI에서 기능, 객체 또는 워크플로에 대해 개념적 또는 일반적으로 말할 때는 sentence case를 사용하세요. 백틱 같은 특수 형식을 사용하지 마세요. 이렇게 하면 가독성이 좋아지고 객체를 일반 명사로 취급하게 돼요.

언제 사용하나요: 설명 텍스트, 도움말 텍스트, 또는 워크플로를 설명할 때.

예시:

  • "You can attach a persistent volume to your pod to ensure data is saved."
  • "After you create your storage class, it can be used by any developer in the namespace."
  • "View resource usage."
  • "Ensure all storage class names are defined in the manifest."
기술적 API 참조 (정확한 대소문자) (Technical API references)

실제 API 객체나 기본 리소스 타입(예: 커스텀 리소스 정의)을 구체적으로 참조할 때는 API 사양에 정의된 정확한 대소문자를 사용하세요. 이 참조를 어떻게 형식화할지는 UI에서 어디에 나타나는지에 달려 있어요.

본문 텍스트에서: 백틱, 대괄호 또는 기타 코드 형식을 사용해서 API 참조를 산문과 시각적으로 구분하세요.

  • PascalCase 예시: "The PersistentVolume must be in a Bound state."
  • camelCase 예시: "Ensure the storageClassName is defined in the manifest."
  • snake_case 예시: "The system checks the volume_id before mounting."

내비게이션 항목과 페이지 제목에서: API 대소문자를 정확히 맞추세요. 인터페이스를 깔끔하게 유지하기 위해 이 영역에서는 백틱이나 코드 형식을 사용하지 마세요. 이 페이지들은 일반적인 개념이 아닌 특정 데이터 객체의 뷰예요.

  • 내비게이션 항목 예시: StorageMap
  • 페이지 제목 예시: StorageMap details

동작 버튼에서: 동작이 API로 정의된 객체를 만든다면, 버튼 라벨은 해당 API 리소스의 정확한 대소문자를 사용해야 해요. 리소스 이름의 단수형을 사용하세요. 백틱이나 코드 형식을 사용하지 마세요.

  • 예시: Create UserDefinedNetwork

예시:

API 리소스 sentence case (일반) 정확한 API 대소문자 (기술)
VirtualMachine "You can migrate your existing virtual machines from VMware directly into OpenShift." "The VirtualMachine must be in a Stopped state before you can change the CPU limits."
instanceType "You can choose an optimized instance type to improve the performance of your database workloads." "The controller will return a validation error if the instanceType is not supported by the underlying cloud provider's region."

제품 포트폴리오 외부의 도구 (Tools outside your product portfolio)

회사 제품 포트폴리오에 속하지 않는 도구를 언급한다면, 해당 회사의 문서에 나타나는 대로 제품 이름을 쓰세요.

예를 들어 Amazon Web Services에서 Amazon이 대문자로 쓰는 제품을 언급한다면, 당신도 글에서 그 제품을 대문자로 써야 해요.

PatternFly 웹사이트 문서 (PatternFly website documentation)

PatternFly 콘텐츠(문서나 마이크로카피 같은)에 기여한다면 따라야 할 추가 대문자 표기 지침이 있어요.

  • 페이지 제목, 메뉴 항목, 내비게이션 항목, 헤딩, 소제목, 부제에 sentence case를 사용하세요.

  • 고유명사, 제품명, 두문자어, 이니셜리즘을 대문자로 쓰세요. 예: React, PatternFly, HTML.

PatternFly 웹사이트를 예로 들면, 모든 내비게이션 항목, 버튼 텍스트, 헤딩이 sentence case로 작성되고 모든 고유명사가 title case로 작성돼요:

  • 문장을 시작하지 않는 한 모든 컴포넌트를 소문자로 쓰세요.

  • 코드 스니펫은 해당 언어의 표준에 따라 형식화하세요.

예를 들어 우리 컴포넌트 문서의 다음 이미지는 컴포넌트 이름에 소문자("card")를 사용하고 코드를 적절히 대문자화("isCompact"와 "isLarge")해요.

더 알아보기 (Learn more)