Document Convention
- HIG를 읽는 많은 사람들이 HIG를 쉽게 이해할 수 있도록 돕자!!
-
글의 첫 시작은 해당 번역의 목적과 이유를 설명합니다.
❗ 본 문서는 Apple의 Human Interface Guideline(이하 HIG) 문서를 한글로 번역한 것입니다. iOS 생태계 내에서 HIG를 읽으시는 분들이 번역본이 없어 불편함을 겪는 것을 알게 되었고, 이에 한글로 번역을 하게 되었습니다. iOS 커뮤니티 Async Swift에서 자율적으로 모인 9명이 함께 번역했으며, 일체의 상업적인 목적을 띄지 않습니다. 이 문서를 학습에 적극적으로 이용해 주시돼, 상업적인 용도로 이용하시는 것은 지양해 주시기 바랍니다. 감사합니다. -
Apple HIG의 계층 구조를 따라 목차를 작성합니다.
- 문서의 요약 및 설명은 Introduction 제목을 기입후 작성합니다. 요약은 볼드처리 해줍니다.
-
글의 내용 및 HIG에서 사용되는 모든 이미지는 라이트 모드를 기준으로 작성합니다.
- 예 ) 썸네일, 아이콘, 예시 이미지 등 글의 무드를 결정짓는 요소들
-
기본적으로 어색한 문장이나 단어는 이해하기 쉽게 수정합니다. → Word Convention 참고
-
주제 또는 소주제 등은 모두 영문으로 작성합니다.
-
HIG 문서에서 볼드 처리된 문장은 동일하게 볼드 처리합니다.
-
링크가 걸려있는 단어는 영어로 작성합니다.
-
애매하거나 혼동할 수 있는 단어는 한국어(Eng)로 함께 표기합니다.
-
단어에 대한 부가적인 설명이 필요한 경우 역자설명으로 설명합니다.
- 역자설명 폐쇄 자막(Closed Caption) : 자막을 숨기거나 영상에 표시할 수있게 사용자가 선택할 수 있는 자막의 형태 CC 라고 표시 -
목차가 끝났을 경우 나눔선으로 구분해 줍니다.
-
링크, 숫자(해상도 등), 표같은 설명이 너무 많은 경우 페이지 링크를 걸고 역자 설명을 남깁니다.
- 역자설명 자세한 설명은 [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/foundations/color#platform-considerations)을 참고하세요. -
HIG의 예시 사진 또는 역자가 들고온 참고용 예시 사진등은 피그마의 템플릿을 적용해 글의 일관성을 유지합니다.
-
글을 읽는 사람들을 위한 다양한 예시 이미지 또는 설명글을 역자설명으로 작성합니다.
-
IMPORTANT 는 다음과 같이 작성합니다.
🔥 **IMPORTANT** 법적 요구 사항으로 인해 앱에서 디지털 건강 기록과 같은 계정 또는 정보를 유지하거나 특정 계정 삭제 프로세스를 따라야 하는 경우 사람들이 유지해야 하는 정보 또는 계정과 따라야 하는 프로세스를 이해할 수 있도록 상황을 명확하게 설명합니다. -
NOTE 는 다음과 같이 작성합니다.
📝 **NOTE** 사람들이 구독을 구매하기 위해 앱을 사용하지 않았더라도 계정 삭제를 활성화해야 합니다.
- Platform considerations 는 다음과 같이 작성합니다.
→ 영문 그대로, 이탤릭체
- Resources는 다음과 같이 작성합니다.
기본적으로 HIG 의 Resources를 그대로 복사해서 붙입니다. 이후 Videos의 크기를 조절해서 위와 같이 정리합니다.
-
Changelog는 다음과 같이 작성합니다. # Changelog
> September 23, 2022 New page. >