Wordpress

WordPress документация: Есть ли хорошая документация WordPress на русском языке? — Хабр Q&A

14.03.2023

Содержание

Ultimate Guide For A Better WordPress Documentation For Any Plugin Developer

Если вы разработчик, который делает плагины для WordPress, то настройте WordPress документация или база знаний должна быть неотъемлемой частью вашей стратегии поддержки клиентов. В конце концов, вам может быть очень легко использовать собственный плагин, но вашим потенциальным клиентам или конечным пользователям может потребоваться надлежащее руководство, чтобы по-настоящему понять, как работает ваш плагин.

🎁 Get Free Access to BetterDocs PRO​ Мы исключительно предлагаем BetterDocs PRO для разработчиков плагинов WordPress. Если вы являетесь разработчиком плагинов, продолжайте читать, чтобы найти предложение.

По этой причине вам обязательно следует подумать о том, чтобы потратить время на настройку правильного, информативного и полезного документация к плагину для пользователей вашего продукта. Без предложения документация к плагину для ваших пользователей вам и вашей команде будет трудно добиться успеха, так как вы будете получать тонны билетов поддержки.

Только представьте, что бы вы чувствовали, если бы купили новую стиральную машину, но не знали, как заставить ее работать, потому что она пришла без каких-либо инструкций или руководства пользователя. Вы можете позвонить в службу поддержки клиентов, но вам придется долго ждать в очереди, пока служба поддержки ответит на все остальные вопросы.

Итак, если вы Разработчик плагинов WordPress и вы хотите, чтобы ваши клиенты имели хороший опыт работы с вашими продуктами, а затем рассмотрите возможность создания находчивой документации WordPress, которую им было бы легко использовать и понимать.

Говоря о важности документации для плагинов WordPress,

Вова Фельдман, Основатель Freemius общий: 

«With proper documentation, you & your support team can work more efficiently by referring users to documented topics instead of writing them over and over again. It improves the UX for users that are comfortable finding solutions in a self-serve approach which naturally reduces the support load. »

Оглавление

⭐ Все, что нужно знать о документации WordPress

Главный цель документации is to provide your users with detailed information about how they can use your product. 

It is much more comprehensive than a simple Часто задаваемые вопросы (Часто задаваемые вопросы) Страница должна быть легко читаемой и понятной даже для людей, не обладающих техническими знаниями о вашем продукте.

To sum it up in a nutshell, your WordPress documentation acts as the user manual for your product and should make your end-users feel like an expert when they are using your plugins. 

От обучения пользователей тому, как установить и активировать ваш плагин, до настройки параметров и настройки с различными функциями, убедитесь, что документация вашего плагина отвечает на как можно больше вопросов.

Давайте посмотрим, почему это так важно для любого разработчика плагинов. Ниже мы дадим вам очень краткий обзор всех возможностей, которыми может помочь документация плагина.

Assist Non-Technical Users To Understand Your WordPress Plugin: Хотя некоторые из ваших конечных пользователей могут иметь технические знания, большинство пользователи WordPress, как правило, имеют нетехническое происхождение. Это означает, что вам нужно предложить документацию для вашего плагина WordPress, которую легко понять нетехническим пользователям.

Enhance User Experience With A Detailed WordPress Documentation: 

Если ваши пользователи смогут выяснить, как использовать ваш плагин WordPress, просто просмотрев предоставленную вами документацию по плагину, они почувствуют себя уполномоченными и довольными вашим плагином WordPress.

Reduce Support Tickets & Workload On Your Team: Хорошая документация WordPress может помочь вам сократить количество обращений в службу поддержки и снизить нагрузку на вашу службу поддержки. Если ваши конечные пользователи смогут решить большинство своих проблем, прочитав документацию по плагину, им не нужно будет обращаться в вашу службу поддержки.

Safeguard Yourself From Negative Reviews:

 Без надлежащей документации WordPress ваши пользователи могут не понять, как работает ваш плагин. Очень вероятно, что ваши пользователи будут так расстроены, что в конечном итоге они могут оставить негативные отзывы о ваших плагинах. Поэтому, чтобы защитить себя от негативных отзывов, предложите документацию WordPress с богатым содержанием.

SEO Benefits of Documentation: Хотя наличие надлежащей документации поможет вам предоставить клиентам всю необходимую им информацию, но это будет неэффективно, если клиенты не смогут узнать, где получить к ней доступ. Здесь база знаний может быть сравнительно простым способом занять верхнюю позицию в поиске Google, если вы правильно оптимизировали свою документацию для трафика из поисковых систем.

Контент является одним из четырех основных факторов ранжирования для алгоритма SEO Google, а документация является одним из источников контента для вашего веб-сайта, так как он более вероятно ранжируется на верхних страницах с надлежащей оптимизацией.

To Руководство по настройке ресурсоемкой документации WordPress

Чтобы создать полезную документацию WordPress с большим содержанием, вам необходимо следовать нескольким основным правилам. Мы собираемся взглянуть на них сейчас.

Используйте простой язык для документации плагинов

Помните, что цель документации WordPress — облегчить пользователям понимание того, как использовать ваш плагин. без needing technical expertise. 

Avoid using technical jargons as users who do not have technical knowledge will not be familiar with those terms.

Обеспечьте удобство чтения для ваших пользователей

Информативная и находчивая документация WordPress, вероятно, будет содержать много контента. Чтобы облегчить пользователям быстрое чтение всего содержимого в документации к плагину, используйте короткие абзацы, изображения, списки, маркеры, оглавление и многое другое. Все это поможет сделать вашу документацию WordPress более удобной для чтения.

Следуйте правильной структуре для вашей документации WordPress

Эффективная и полезная документация WordPress будет иметь правильную структуру. Это означает, что весь контент в документации вашего плагина будет следовать последовательным пошаговым инструкциям.

Например, все плагины WordPress необходимо активировать после установки. Если вы пропустите шаг по активации плагина, многие пользователи могут не понять, почему ваш плагин не работает для них. Поэтому, когда вы пишете документацию по плагину, следуйте правильной последовательной структуре, которая имеет смысл для ваших конечных пользователей.

Чтобы получить лучшее представление о том, как выглядит высококачественная документация плагина WordPress, ознакомьтесь с этими страницами документации, созданными для некоторых популярных плагинов WordPress.