대부분의 패키지에는 사용자 경험을 최적화하고 사용을 최적화하기 위한 설명이 필요합니다. 이 페이지에서는 정보 구조화 및 문서 포맷 지정 방법에 대한 몇 가지 팁을 제공합니다.
패키지 제목 뒤에 패키지와 해당 콘텐츠에 대한 기본 개요를 제공합니다. 개요와 패키지 콘텐츠 뒤에 설치 지침, 시스템 요구 사항, 제한 사항을 포함합니다. 공개 포럼이나 기술 자료 등 도움을 받고 피드백을 제공할 수 있는 링크와 지원 담당자도 제공할 수 있습니다.
이러한 사전 정보 다음에는 더 자세한 워크플로, 사용자 인터페이스에 대한 설명이나 샘플의 디렉토리 리스트, 더 고급 항목을 제공할 수 있습니다. 마지막에 참조 페이지를 넣는 것이 가장 좋습니다.
| 섹션 | 설명 |
|---|---|
| 개요 | 패키지에 대한 간단하고 수준 높은 설명을 제공합니다. |
| 패키지 콘텐츠 | 사용자에게 알려 줄 중요한 파일의 위치가 포함되어 있습니다. 예를 들어 텍스처, 모델, 머티리얼이 샘플 그룹으로 구분된 샘플 패키지인 경우 각 그룹의 폴더 위치를 지정할 수 있습니다. |
| 설치 지침 | 공식 패키지 관리자 설치 지침을 참조할 수 있지만 샘플 설치와 같은 특별한 설치 요구 사항이 있을 경우 여기에 추가합니다. |
| 요구 사항 | 이 부분은 이 패키지와 호환될 수 있는 Unity 에디터 버전을 포함하여 하드웨어 또는 소프트웨어 요구 사항을 추가하기 좋은 부분입니다. |
| 제한 사항 | 패키지에 알려진 제한 사항이 있는 경우 여기에 나열할 수 있습니다. 제한 사항이 없거나 거의 없는 경우 이 섹션을 제외합니다. |
| 워크플로 | 사용자가 따라 할 수 있는 단계 목록을 포함하여 기능을 사용하는 방법을 설명합니다. 기능을 사용하는 방법을 설명하기 위해 스크린샷을 포함할 수 있습니다. |
| 고급 항목 | 사용자에게 제공하는 내용에 대한 상세 정보입니다. 너무 많은 정보로 사용자에게 부담을 주지 않으려는 경우에 적합합니다. |
| 레퍼런스 | 사용자 인터페이스에 프로퍼티가 많은 경우 레퍼런스 섹션에 세부 정보를 설명할 수 있습니다. 표를 통해 특정 프로퍼티를 설명하는 것도 좋은 방법입니다. |
| 샘플 | 샘플 파일이 포함된 패키지에는 사용자가 프로젝트와 씬에서 이 샘플 파일을 사용할 수 있는 방법에 대한 자세한 내용을 넣을 수 있습니다. |
| 튜토리얼 | 복잡한 절차에 대한 설명을 제공하려는 경우 여기에 추가해도 됩니다. 사용자가 이해하는 데 도움이 되는 경우 단계별 지침을 사용하고 이미지를 포함합니다. |
마크다운은 패키지에 일반적으로 사용되는 경량 포맷입니다. 많은 저장소 호스팅 서비스(예: GitHub, Bitbucket)는 README 파일 및 문서 사이트에 대한 마크다운을 지원합니다. 패키지 루트 아래의 Documentation~ 폴더에 마크다운 파일을 포함할 수 있습니다. 그런 다음 사용자가 Unity의 패키지 관리자 창의 세부 정보 패널에서 문서 링크를 클릭하면 사용자의 기본 마크다운 뷰어에 파일이 열립니다.
자체 웹사이트를 사용하여 문서를 호스팅할 수도 있습니다. 자체 웹사이트를 가리키도록 문서 링크의 위치를 설정하려면 package.json 파일의 documentationUrl 프로퍼티를 사용하여 설정합니다.
마크다운을 사용하여 패키지를 문서화하기로 결정한 경우 다음과 같은 여러 사이트에서 마크다운 파일 작성에 대한 정보를 찾을 수 있습니다.