대부분의 패키지는 사용자가 최고의 경험을 하고 최적으로 사용할 수 있도록 도와줄 설명의 형태가 필요합니다. 이 페이지에서는 정보 구조화와 문서화 형식 방법에 대한 몇 가지 팁을 제공합니다.
패키지의 제목 다음에는 패키지의 기능 그리고/또는 패키지의 내용에 대한 기본 개요를 제공해야 합니다. 개요 다음에는 설치 지침과 시스템 요구 사항 그리고/또는 제한 사항을 포함합니다. 또한 도움말과 피드백, 공용 포럼이나 기술 자료, 업무 지원 연락처가 포함된 링크를 제공할 수 있습니다.
이 사전 정보 다음에는 더 자세한 워크플로, 사용자 인터페이스에 대한 설명이나 샘플에 대한 디렉토리 리스트 그리고 더 고급 항목을 제공할 수 있습니다. 마지막엔 참조 페이지를 넣는 것이 가장 좋습니다.
섹션 | 설명 |
---|---|
개요 | 패키지에 관한 간단하고 고수준의 설명을 제공합니다. |
패키지 콘텐츠 | 사용자에게 알리고자하는 중요한 파일의 위치를 포함합니다. 예를 들어 이 패키지 콘텐츠가 샘플 그룹으로 나뉘어진 텍스처, 모델, 머티리얼이 포함된 샘플 패키지라면 각 그룹의 폴더 위치를 제공할 수 있습니다. |
설치 지침 | 공식 패키지 관리자 설치 지침을 표시할 수 있지만 샘플 설치와 같이 다른 특별 설치 요구 사항이 있을 경우 여기에 추가합니다. |
요구 사항 | 이 부분은 이 패키지와 호환될 수 있는 Unity 에디터 버전을 포함하여 하드웨어 또는 소프트웨어 요구 사항을 추가하기 좋은 부분입니다. |
제한 사항 | 패키지에 알려진 제한 사항이 있을 경우 여기에 나열할 수 있습니다. 제한 사항이 없거나 미미한 경우 이 섹션을 제외합니다. |
워크플로 | 사용자가 쉽게 따라할 수 있도록 기능 사용 방법을 설명하는 단계에 대한 리스트를 포함합니다. 기능 사용 방법을 설명하는 데 도움이 되도록 스크린샷을 넣을 수 있습니다. |
고급 항목 | 이 부분에서는 사용자에게 제공하는 사항에 대한 세부 정보를 제공할 수 있습니다. 이 부분은 앞에서 너무 많은 정보로 사용자에게 부담을 주고 싶지 않을 때 이상적입니다. |
레퍼런스 | 사용자 인터페이스에 프로퍼티가 많을 경우 레퍼런스 섹션에서 해당하는 세부 사항을 다룰 수 있습니다. 표를 사용하여 특정 프로퍼티 설명을 빨리 찾을 수 있도록 하는 방법도 좋습니다. |
샘플 | 샘플 파일이 포함된 패키지에는 사용자가 프로젝트와 씬에서 이 샘플 파일을 사용할 수 있는 방법에 대한 자세한 내용을 넣을 수 있습니다. |
튜토리얼 | 복잡한 절차에 대한 자세한 설명을 제공하고자 하는 경우 여기에 추가할 수도 있습니다. 사용자가 이해하는 데 도움이 될 경우 이미지를 포함하고 단계별 지침을 사용합니다. |
Markdown은 패키지에서 일반적으로 사용되는 가벼운 포맷입니다. GitHub와 Bitbucket과 같이 많은 저장소 호스팅 서비스는 README와 문서 사이트에 대해 이 포맷을 지원합니다. 패키지 루트의 폴더명이 Documentation
으로 시작하는 폴더에 MD 파일을 제공할 수 있으며 패키지 사용자가 Unity 패키지 관리자의 세부 정보 창에 있는 View documentation 링크를 클릭하면 사용자의 기본 MD 뷰어로 파일이 열립니다.
또는 자체 웹사이트를 사용하여 문서를 호스팅할 수도 있습니다. View documentation 링크가 자체 웹사이트로 연결되도록 위치를 설정하려면 package.json
파일의 documentationUrl 프로퍼티로 설정합니다.
Markdown 파일을 사용하여 패키지를 문서화하기로 결정한 경우 다음과 같은 여러 도움말 사이트에서 MD 파일을 작성하는 방법에 대한 정보를 찾을 수 있습니다.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
방문하는 모든 웹사이트의 정보가 브라우저에서 쿠키 형태로 저장되거나 수집될 수 있습니다. 본 정보는 귀하와 귀하의 선호도, 기기에 대한 것이며, 귀하의 선호도에 따라 사이트가 동작하도록 하는 데 사용됩니다. 본 정보는 귀하를 직접적으로 식별하지 않으나 보다 개인화된 웹 경험을 제공하기 위해 사용됩니다. 그러나 일부 쿠키를 거부할 수 있습니다. 더 자세한 정보를 확인하고 기본 설정을 변경하려면 해당 카테고리의 제목을 클릭하세요. 그러나 일부 쿠키를 차단하면 귀하의 사이트 경험과 회사에서 제공하는 서비스에 영향을 미칠 수 있습니다.
추가 정보
본 쿠키는 동영상 및 실시간 채팅과 같은 고급 기능과 개인화를 허용합니다. 쿠키는 회사 또는 회사 페이지에 추가된 제3 서비스 사업자가 설정할 수 있습니다. 쿠키를 허용하지 않으면 일부 기능이 정상 작동하지 않을 수 있습니다.
이 쿠키는 방문자 수, 데이터 트래픽 정보를 확인해 회사 사이트의 성능을 측정하고 개선할 수 있도록 합니다. 또한 가장 인기가 많거나 인기가 적은 페이지를 확인하며 방문자가 사이트를 이동하는 방법을 확인할 수 있도록 합니다. 쿠키가 수집하는 모든 정보는 누적되며 익명 처리됩니다. 쿠키를 허용하지 않으면 귀하가 회사 사이트에 방문한 시기를 알 수 없습니다.
이 쿠키는 회사의 광고 협력사가 회사 사이트에 설정한 것입니다. 해당 협력사는 귀하의 관심사에 대한 프로파일을 만들고 다른 사이트에서도 관련 광고를 표시하기 위해 이 쿠키를 사용합니다. 이 쿠키는 귀하의 브라우저와 기기를 식별함으로써 동작합니다. 이 쿠키를 허용하지 않으면 다른 웹사이트에서 회사가 제공하는 맞춤형 광고를 경험할 수 없습니다.
이 쿠키는 웹사이트의 기능을 위해 필수적이며, 회사 시스템 내에서 종료할 수 없습니다. 이 쿠키는 개인정보 선호도, 로그인 또는 양식 작성과 같은 서비스 요청에 해당하는 귀하의 행위에 따라서만 주로 설정됩니다. 귀하의 브라우저에서 이 쿠키를 차단하거나 쿠키에 대해 알림 설정을 할 수 있지만, 이 경우 해당 사이트의 일부 기능이 동작하지 않을 수 있습니다.