ほとんどのパッケージは、ユーザーが最高の体験をし、使用を最適化できるように、何らかの形で説明が必要です。このページでは、情報の構成 と ドキュメントの形式 についてのヒントを紹介します。
After the title of the package, give a basic overview of the package and its contents. Following the overview and package contents, include instructions for installing, system requirements, and limitations. You can also offer links for getting help and providing feedback, including public forums or knowledge bases, and support contacts.
After this preliminary information, you can offer more in-depth workflows, description of the user interface or directory listings for samples, and then more advanced topics. It’s best to offer reference pages near the end.
| セクション | 説明 |
|---|---|
| Overview (概要) | A brief, high-level explanation of the package. |
| Package contents (パッケージ内容) | Include the location of important files you want the user to know about. For example, if this is a sample package containing textures, models, and materials separated by sample group, you might want to specify the folder location of each group. |
| Installation instructions (インストール方法) | 公式の Package Manager インストール手順 を紹介することができますが、サンプルのインストールなど特別なインストール要件がある場合は、ここに記載してください。 |
| Requirements (要件) | このパッケージがどのバージョンの Unity エディターに対応しているかなど、ハードウェアやソフトウェアの要件の説明すに適した場所です。 |
| Limitations (制限事項) | パッケージに既知の制限がある場合、それをここに記載します。そうでない場合、または制限が些細なものである場合は、このセクションは除外できます。 |
| Workflows (ワークフロー) | Include a list of steps that the user can follow that demonstrates how to use the feature. You can include screenshots to help describe how to use the feature. |
| Advanced topics (高度なトピック) | Detailed information about what you’re providing to users. This is ideal if you don’t want to overwhelm the user with too much information up front. |
| Reference (参照) | If you have a user interface with a lot of properties, you can describe their details in a reference section. Using tables is a good way to offer specific property descriptions. |
| Samples (サンプル) | サンプルファイルが含まれているパッケージでは、ユーザーがプロジェクトやシーンでこれらのサンプルファイルをどのように使用できるかについての詳細な情報を含めることができます。 |
| Tutorials (チュートリアル) | If you want to offer walkthroughs for complicated procedures, you can also add them here. Use step-by-step instructions and include images if they can help the user understand. |
Markdown is a lightweight format commonly used in packages. Many repository hosting services (such as GitHub and Bitbucket) support Markdown for README files and documentation sites. You can include a Markdown file in the Documentation~ folder under your package root. Then, when a user clicks the Documentation link in the details panel of Unity’s Package Manager window, the user’s default Markdown viewer opens the file.
You can also use your own website to host your documentation. To set the location for the Documentation link to point to your own website, set it with the documentationUrl property in your package.json file.
If you decide to use Markdown to document your package, you can find information about writing Markdown files from many sites, including: