README плагина — первое, что пользователи видят на странице с описанием в Интеллос Маркетплейс. Добавление переводов позволяет пользователям, не владеющим английским, читать вашу документацию на родном языке, не теряя оригинал.

Спецификации файлов

Все файлы должны быть в кодировке UTF-8. Английский README.md всегда остаётся в корне плагина; все остальные языки помещаются в подкаталог readme/.

Рекомендуемая структура

Делайте README лаконичными, до ~500 слов. Страница с описанием в Маркетплейс показывает README напрямую, поэтому оптимизируйте его для того, кто решает, стоит ли устанавливать плагин:
Не помещайте в README полный справочник по API или заметки по разработке; их место — в комментариях исходного кода или на отдельном сайте документации. Аудитория Маркетплейс — конечные пользователи, выбирающие плагин, а не участники, читающие ваш код.

Как Маркетплейс выбирает язык

Когда посетитель открывает страницу с описанием вашего плагина, Маркетплейс ищет README, соответствующий языку его интерфейса. Если соответствие найдено в каталоге readme/, отображается этот файл. В противном случае используется запасной вариант — английский README.md.
Страница с описанием плагина (английский)
Языковые коды сопоставляются точно: README_zh_Hans.md обслуживает только упрощённый китайский; пользователи с традиционным китайским видят английский запасной вариант.

Редактировать эту страницу | Сообщить о проблеме