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