Документация

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

Документация привязана к карточке/товару, а не к отдельному релизу. В текущей версии системы у товара есть одна актуальная документация. Версионная документация и многофайловая структура будут добавляться отдельно, если появится реальная потребность.

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

• установить продукт;
• активировать лицензию;
• выполнить базовую настройку;
• обновиться;
• решить типовые ошибки;
• понять, что приложить в поддержку.

Качественная документация к компоненту должна содержать следующие разделы:

1. Общая информация — кратко объясните, что делает дополнение и кому оно нужно.
2. Установка — опишите установку по шагам.
3. Активация лицензии — покажите, где указать product_id, license key и site_url.
4. Настройка — разберите основные опции.
5. Использование — опишите регулярное использование дополнения админом и полезователем.
6. Проверка обновлений — объясните, как пользователь проверяет и устанавливает обновления.
7. Частые проблемы — соберите типовые ошибки и решения.
8. Поддержка — напомните, что покупатель может открыть вкладку Помощь или Багрепорт.

Если документация устарела, количество обращений в поддержку растет, а возвраты становятся вероятнее.

Более подробно о написании документации и правилах загрузки на сайт читайте в Технической документации.