String Key 작성 가이드

개요

String 시트에 String Key 를 작성하고 관리하는 방법이다. 규칙을 엄격하게 강제하지는 않지만 준수를 권장한다. 운영 비용(찾기·수정·번역·QA)을 줄이고 품질을 올리는 데 가장 효과적이기 때문이다.

적용 범위

축	적용 / 제약
대상	String 시트의 키와 값
담당	도메인 담당 PMPD

상세 내용

1. 키 작성 규칙

• 영어 소문자·.·_·숫자로 쓴다.
• 띄어쓰기가 포함된 용어는 띄어쓰기 대신 밑줄을 쓴다. sign up 은 sign_up 이다.
• 항상 string. 으로 시작한다. 예: string.workspace.settings.name
• 정보는 필요한 만큼 충분히 적는다.
  • workspace 처럼 하위 영역과 기능이 많은 도메인은 계층을 더 길게 적는 편이 좋다. string.workspace.abc.label 처럼 너무 짧으면 나중에 구분하기 어렵다.
  • common 처럼 범용적인 String 은 2~3단계면 충분한 경우가 많다. 예: string.common.cancel.label
• 마지막은 접미사로 끝낼 수 있다. 사용 가능한 접미사 목록은 시트의 Readme 에 있다.

바쁘면 가능한 선에서만 작성해도 된다. 기본 규칙만 지켜서 시트에 「대부분」이 규칙적으로 쌓여 있으면 어긋난 값이 눈에 띄어 나중에 정리하기 쉽다.

2. 시트에 추가하는 방법

• 키는 영역(도메인)별로 시트가 나뉘고, 시트 안에서도 구분행으로 카테고리가 나뉜다.
• 가능하면 추가하려는 키의 카테고리를 찾아 그 근처에 새 행으로 추가한다.
• 정말 바쁘면 맨 아래에 추가해도 되며 이후에 정리할 수 있다.

3. 값 작성과 임시 번역

• 새로 추가하는 값은 한국어와 영어까지 적으면 좋다. 영어가 있으면 키를 작성하고 리뷰할 때 참고하기 쉽다.
• 다른 언어가 비어 있으면 DeepL 함수로 임시 번역해 둘 수 있다.
• DeepL 함수로 번역한 셀은 셀 색상을 노란색으로 표시한다.
• 번역 후에는 값만 남겨서 함수가 재실행되지 않게 할 수 있다. 함수가 남아 있어도 큰 문제는 없으며 추후에 정리한다.
• 임시 번역본은 이후 번역 서비스를 통해 정식 번역으로 교체한다.

여유가 되면 담당 도메인의 String 을 시트 안에서 분류하고 정리할 수 있다. 분류가 되어 있으면 이후 개선 작업과 번역 품질·속도가 크게 좋아진다.

4. 하나의 키는 언제나 같은 맥락을 전달한다

같은 UI 영역에 쓰이는 String 값은 언어가 달라져도 같은 의미와 맥락을 전달해야 한다.

String Key	KO	EN	JA
string.common.save.label	저장	Save	保存

핵심은 하나의 String Key 에 연결된 각 언어별 번역 값이 서로 같은 의미를 가져야 한다는 것이다. 키와 번역 값 사이의 의미 일관성이 보장되어야 번역 품질 관리와 갱신이 체계적으로 이루어진다.

5. 언어별로 다른 맥락이 필요하면 키를 새로 만든다

특정 언어에만 다른 문구를 제공해야 하는 경우, 기존 키의 특정 언어 값만 바꾸지 않고 별도의 String Key 를 새로 만든다.

한 언어에서만 쓰는 키라 하더라도 그 키 안의 모든 언어별 값은 같은 의미를 유지해야 한다. 하나의 키 안에서 언어별로 의미가 달라지면 이후 번역 관리와 QA 과정에서 맥락 추적이 어려워지고 품질 저하로 이어진다.

확인 필요

항목	사유	확인 방법
접미사 목록의 소재	「Readme 시트에서 확인해 주세요」라고만 적고 목록을 담지 않는다. 시트가 이동하면 접미사 규칙이 사라진다	접미사 목록을 이 문서에 옮길지 결정한다
규칙을 강제하지 않는 상태의 지속 여부	「엄격하게 강제하진 않지만 권장한다」고 적는다. 시트가 커질수록 정리 비용이 커진다	현지화 담당자에게 검증 도구 도입 계획을 확인한다
DeepL 임시 번역의 정식 교체 시점	「이후 번역 서비스를 통해 교체할 예정」이라고만 적는다	노란색 셀이 얼마나 남아 있는지 확인한다

관련 문서

대상	경로
String 업데이트 워크플로우	product-service/miricanvas/string-update-workflow.md
번역 String 값 표기 규칙	product-service/miricanvas/string-notation-rule.md
미리캔버스 UX Writing 원칙	product-service/miricanvas/ux-writing-principles.md
미리디 용어(Glossary) 관리 방법 개선	corporate/work-tools/glossary-management.md