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