Процесс превращения в проверенное решение
Программа Verified Solutions демонстрирует инструменты и сервисы, которые обеспечивают дополнительную функциональность для пользователей Unity. Эти продукты могут, например, включать комплекты разработки программного обеспечения (SDKs), плагины и расширения редактора, среди других предложений. Программа Verified Solutions не подходит для сторонних продуктов, которые предоставляют только пакеты ассетов, такие как 3D модели, аудио и спрайты.
Для начала процесса проверки решения должны отвечать следующим требованиям.
Соблюдение руководящих принципов представления Asset Store
Перед подачей заявки на участие в программе проверенных решений ознакомьтесь с Asset Store Руководящие принципы подачи заявок. Используйте Asset Store Инструменты Инструмент проверки для соблюдения всех применимых руководящих принципов.
Решение готово к выпуску
Решение должно быть готовым к выпуску, что означает, что продукт удовлетворяет следующим критериям:
- Прошёл все внутренние процедуры контроля качества.
- Соответствует Unity Asset Store руководящим принципам.
- В состоянии готовности к выпуску.
Готовность к выпуску включает все аспекты решения, с которыми пользователи взаимодействуют во время использования продукта. Например, если решение зависит от веб-интерфейсов для управления функциями, такими как портал администрирования, связанные веб-сайты должны быть готовы для использования потребителями. Любые функции, находящиеся в стадии разработки или экспериментальные, должны быть четко обозначены и предоставляться отдельно от основных функций. Пользователи должны иметь возможность использовать все основные функции решения независимо от экспериментальных функций.
Подробная документация
Вы должны предоставить подробную и обширную документацию для решения, которая должна соответствовать следующим требованиям:
- Включает список поддерживаемых потоков и платформ Unity.
- Обрисовывает неподдерживаемые графические конвейеры (такие как HDRP, URP или Встроенный) и серверы скриптов (такие как Mono или IL2CPP).
- Документы ограничения или необычные процедуры установки.
- Подробно описывает процесс интеграции и все функции, доступные пользователю, с примерами, когда это возможно.
- Документы, все публично доступные и предназначенные для использования APIs с описаниями передаваемых и возвращаемых параметров и всех возможных исключений, с которыми пользователь может столкнуться.
- Предоставляет примеры использования core APIs.
- Представляет известные проблемы и временные решения.
- Включает changelog изменений продукта.
- Журнал изменений предоставляет информацию клиентам и помогает ускорить процесс проверки проверенных решений, особенно если решение требует повторной проверки.
- Журнал изменений должен включать описания новых добавленных и обновленных функций, а также исправлений ошибок, которые имеются в каждой версии.
Наряду с онлайн-документацией вы должны предоставить одностраничное резюме с описанием основных функций решения и ссылками на полную онлайн-документацию и журнал изменений. Вы также можете предоставить автономную версию полной документации и журнала изменений для текущей установленной версии продукта.
Структура чистого раствора
Решение должно находиться в своей собственной папке, что может помочь клиентам поддерживать организованную структуру проекта, особенно когда они используют много сторонних продуктов. Некоторые решения могут требовать специальных папок, которые требуют определенного пути для правильной работы. Когда решение требует такой структуры файлов, создайте папку с именем решения внутри необходимой специальной папки.
Примечание: не включайте в продукт неиспользуемые ассеты и не поставляйте вместе с решением внутренние инструменты разработки.
Чистый код
Все общедоступные коды должны быть чистыми и удобочитаемыми и отвечать следующим требованиям:
- Структура и содержимое скрипта должны использовать унифицированный стиль и следовать единой конвенции именования.
- У всех публичных API должны быть краткие описания или комментарии.
- Названия, описания, ключевые слова и комментарии к кодам должны быть на английском языке.
Демо и образцы
Для новых пользователей необходимо предоставить демонстрацию функций. По возможности, демо-версию следует объединить с решением. Если это значительно увеличивает размер продукта, можно предоставить демо-версию отдельно и указать на нее в документации.
Некоторые решения не подходят для традиционных демо-версий или образцов. Например, некоторые расширения Unity Editor могут работать сразу без дополнительной интеграции. В таких случаях вы можете предоставить короткое видео, чтобы представить продукт новым пользователям и ускорить этап изучения процесса проверки проверенных решений.