Skip to content

[Docs] 사용자 문서 한국어화 및 사용 가이드 개선 #1

Description

@nelu572

배경

현재 README는 영어 중심으로 작성되어 있으며, 패키지의 주요 사용자가 한국어로 빠르게 설치 방법과 컴포넌트 사용법을 확인하기 어렵습니다. v0.1.0 이후에는 실제 Unity 프로젝트에서 반복적으로 설치하고 테스트할 수 있도록 사용자 대상 문서를 정리할 필요가 있습니다.

목표

README를 한국어 중심의 사용자 가이드로 개선하고, 설치 방법, 지원 환경, 컴포넌트별 사용법, 예제, 주의사항, 현재 지원 범위를 명확하게 제공합니다.

구현 범위

  • README 한국어화
  • Git URL 및 disk install 기반 설치 방법 정리
  • 지원 Unity 버전 및 com.unity.ugui 의존성 명시
  • RoundedImage, UIGradient, BetterOutline 사용법 정리
  • 간단한 버튼 구성 예제 추가
  • Mask, Canvas channel, Material, Gradient/Outline 조합 등 주의사항 정리
  • 현재 지원 기능과 미지원 기능 구분

제외 범위

  • Runtime/Editor 코드 수정
  • 기능 추가
  • CHANGELOG의 무조건적인 한국어 번역
  • API 문서 자동 생성 시스템 도입

기술 검토 사항

  • CHANGELOG는 Unity/UPM 패키지 관례상 영어 유지가 더 적절한지 검토
  • README의 주 언어를 한국어로 두되, 패키지명/컴포넌트명/API명은 영어 원문을 유지할지 결정
  • Package Manager에서 보이는 설명과 README 설명의 중복 범위 정리

완료 조건

  • README가 한국어 중심의 사용자 가이드로 갱신됨
  • 설치 방법이 Git URL과 local disk install 기준으로 설명됨
  • 지원 Unity 버전과 의존성이 명시됨
  • 세 컴포넌트의 기본 사용법이 포함됨
  • RoundedImage + UIGradient + BetterOutline 조합 예제가 포함됨
  • 주의사항과 현재 지원 범위가 구분되어 있음
  • CHANGELOG 번역 여부가 문서 관례 기준으로 결정됨

선행/관련 Issue

없음.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions