Руководство по стилю для поверхности адаптера
Для многих пользователей страница настроек — это единственная часть адаптера, которую они когда-либо видят. Именно она определяет, считается ли адаптер простым или сложным, независимо от того, насколько хорошо он на самом деле работает.
Используйте конфигурацию в формате JSON.
Страницы конфигурации называютсяjsonConfig.json Это описывается не как отдельная HTML-страница. Администратор формирует интерфейс на её основе. Это приводит к трём последствиям, все они указывают в одном направлении:
- Сайт выглядит и функционирует так же, как и все остальные.
- Оно автоматически подстраивается под цветовую схему, язык и размер экрана.
- Система продолжит работать, даже если сменится администратор.
Полное описание всех типов полей можно найти в разделе JSON-Config .
Созданные на заказ HTML-страницы — причина того, почему некоторые адаптеры нечитаемы или непригодны для использования на телефоне в темном режиме. Для новых адаптеров такая опция недоступна.
Просто спросите, что нужно.
Каждое поле на странице представляет собой решение, которое должен принять пользователь. Поэтому давайте рассмотрим их по порядку:
- Может ли сетевой адаптер самостоятельно определить IP-адрес? Часто можно выполнить поиск устройств в сети. Вывод списка найденных устройств предпочтительнее, чем поле ввода IP-адреса.
- Существует ли разумная настройка по умолчанию? Если да, введите её. Поле, которое остаётся неизменным в 99 процентах случаев, не должно находиться вверху списка.
- А это вообще необходимо? Интервал запроса, который всё равно никто не меняет, — это лишняя настройка.
Элементы, которые используются редко, следует размещать на отдельной вкладке или за разделом "Экспертный режим", а не на первой странице.
Этикетка
- Опишите, что происходит, а не название поля. Указание "Интервал запроса в секундах" будет полезным.
pollIntervalнет. - Укажите единицы измерения: секунды или миллисекунды, градусы или проценты.
- Тексты справки должны быть краткими. Одно предложение под полем лучше, чем абзац, который никто не читает.
- Переводит всё, включая справочные тексты. Переводчик берёт английский текст и предоставляет переводы на другие языки.
Оставьте отзыв
Пользователю необходимо видеть, сработало ли соединение. Кнопка проверки соединения, предоставляющая четкий ответ, сэкономит больше сообщений на форуме, чем любой текст справки. Если что-то пошло не так, сообщение должно указывать , что нужно делать , а не просто сообщать о сбое.
Доступ к данным
Пароли и ключи хранятся в полях типа password, зашифрованы и передаются посредствомprotectedNative Защищено от контакта с другими адаптерами. См. раздел «Безопасность» .
Перед публикацией ознакомьтесь с информацией.
| Тест | Почему |
|---|---|
| Открыто в обеих цветовых схемах | Устоявшиеся цвета сразу же привлекают внимание. |
| Открыть на другом языке | Становятся очевидными отсутствующие переводы и чрезмерно длинные подписи. |
| Открыть на узкое окно | Многие пользователи настраивают параметры со своего планшета. |
| Сохранить без ввода | Необходимо четко указать, какая именно информация отсутствует. |
| Сохранить, используя ложную информацию | Этот отчет должен быть полезен. |
В качестве образца используются страницы конфигурации хорошо поддерживаемых адаптеров из официального репозитория. Воспроизведение существующих проектов всячески поощряется, поскольку узнаваемость — это главная цель.