Почему нет руководство пользователя

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

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

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

Информация о товаре должна быть передана потребителю на русском языке. Если перевод отсутствует это рассматривается как непредоставление необходимых сведений о товаре. Согласно ст.10 Закона о защите прав потребителей покупателю должны сообщить следующую информацию:

• наименование технического регламента;
• сведения о потребительских свойствах товара;
• стоимость товара и условия его покупки;
• гарантийные сроки и сроки службы;
• инструкцию – правила безопасного использования;
• адрес уполномоченной инстанции;
• сведения о соответствии товаров и услуг
• информацию о правилах продажи.

Когда продавец продает товар без инструкции, он нарушает сразу несколько положений закона:

• п.1 ст.10 Закона о защите прав потребителей, согласно которой продавец обязан своевременно предоставить достоверную информацию о товарах в наглядной и доступной форме.
• п.2 ст.8 Закона о защите прав потребителей, по которой надлежащая информация о товаре передается на русском языке (дополнительно – на языке субъекта РФ и народностей).

Если продавец отказывается возвращать деньги, ссылаясь на то, что использование товара не требует инструкции и предельно простое, то покупатель может сослаться на п.4 ст.12 Закона о защите прав потребителей покупатель не должен обладать специальными знаниями о свойствах и характеристиках товара, поэтому у него должна быть доступная инструкция для применения товара. В частности, покупатель не обязан владеть иностранным языком для того чтобы иметь возможность ознакомиться с инструкцией.

Какие требования может предъявить покупатель к магазину

Покупатель может потребовать от магазина:

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

При возврате потребитель может сослаться на ст.12 Закона о защите прав потребителей, которая дает право в разумный срок отказаться от товара и потребовать возврата денег за него и компенсацию ущерба (например, если здоровью покупателя причинен ущерб из-за отсутствия информации о безопасной эксплуатации).

Согласно Постановлению Пленума ВС РФ от 2012 года №17 «О рассмотрении гражданских дел по спорам о защите прав потребителей» разумным сроком считается срок годности товара, сезонность использования, потребительские свойства и пр.

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

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

При возврате покупателю нужно вернуть товар в торговую точку и предъявить доказательства покупки в данном магазине (чек, выписку и пр.).

Образец претензии о возврате товара из-за отсутствия информации

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

К тому же покупатель имеет право обратиться в суд и потребовать компенсации морального вреда и возврата стоимости товара в принудительном порядке. Если дело дойдет до суда, продавцу придется компенсировать не только стоимость товара, но и заплатить штраф 50%.

Особенности для интернет-магазинов

Покупатели интернет-магазинов могут отказаться от покупки в любое время до передачи товара. А после покупки у них есть 7 дней на то, чтобы вернуть товары. Покупатели могут вернуть товары, купленные онлайн, без объяснения причин  (согласно ст.26.1 Закона о защите прав потребителей).

Если интернет-магазин не предоставил информацию о сроках возврата товаров в письменном виде, то покупатель имеет право отказаться от товара в течение 3 месяцев с момента покупки.

Ответственность магазина за продажу товаров без инструкции

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

• 3000-4000 рублей для должностных лиц;
• 30000-40000 рублей для юрлиц.

Краткое содержание

1. Отсутствие инструкции на русском языке приравнивается к ненадлежащей информации о товаре.
2. Это основание позволяет вернуть деньги за товар, даже если у покупателя нет претензий к его качеству.
3. Для возврата денег нужно обратиться к продавцу с письменной претензией, а если он отказывается вернуть средства – с жалобой в Роспотребнадзор или заявлением в суд.
4. За продажу товара без инструкции на русском языке продавцу грозит административная ответственность в виде штрафа до 40000 рублей.

Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение

Журавлев Денис

Что такое руководство пользователя и для чего его создавать

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

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

Общие советы по созданию пользовательской документации

Перед тем как приступить к созданию руководства, нужно определиться с некоторыми важными моментами. Например, определить, для кого вы его пишете? Кто его будет читать — рядовые пользователи, для которых важны базовые функции продукта, или люди, которым нужны особые, нечасто используемые функции программы/сервиса.

После этого важно подумать о том:

• Где пользователь будет к нему обращаться: дома, на работе, в машине?
• Как часто он будет его просматривать?
• Насколько объективно сложен для понимания продукт?

Из этого можно сделать вывод, насколько интенсивно пользователь будет работать с документацией, а значит уже можно выбрать между сжатым «справочником» или объемным «путеводителем» Также важно, чтобы руководство писал профессионал, знающий продукт. Так что по возможности делегируйте написание техническому специалисту или аналитику, у которого есть полное представление о всех тонкостях продукта.

Определившись со всеми представленными пунктами, станет понятнее, какой нужно использовать стиль изложения, какого объема написать текст. Но помните, что излишне стилистически окрашенные слова мешают пользователю добраться до сути. Так что лучшим вариантом в большинстве случаев будет нейтрально-формальный стиль. Пишите так, чтобы пользователь вас понял. Постарайтесь по возможности избегать технических терминов, но проанализируйте — не сделает ли полное отсутствие терминов ваше руководство бесполезным?

Структура руководства пользователя

После того как вы ответили на предыдущие вопросы, создайте структуру руководства. У любого хорошего «путеводителя» хорошая и логичная структура. Начните с оглавления. Информативное содержание поможет читателю легко ориентироваться в документе.

В первом разделе желательно рассказать общую информацию о программе:

• Для чего создан продукт.
• Какие задачи он решает.
• Какие основные выгоды от использования для клиента.

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

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

Ни одно руководство не обойдется без таких разделов как: «Частые вопросы» и «Устранение типовых проблем» В них разбираются вопросы и проблемы, с которыми часто сталкиваются пользователи. Для заполнения данного раздела вам скорее всего понадобятся уже готовые отзывы клиентов. Если у вас абсолютно новый продукт, вы можете предугадать проблемы ваших клиентов либо на первое время не включать данный пункт в ваше руководство.  

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

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

Но как создать руководство пользователя, если пишешь его впервые? Или что делать, если руководство пользователя нужно постоянно обновлять и дорабатывать? Или нужны особые функции, которых нет в традиционных текстовых редакторах, например, в MS Word.

Одним из популярных инструментов для создания качественного руководства является программа Dr. Explain (https://www.drexplain.ru), в которой уже есть готовые шаблоны руководств пользователя с готовой структурой разделов и в которой удобно обновлять документацию, как бы часто эти обновления не происходили.

Видео-обзор основных возможностей программы Dr.Explain

Удобной особенностью инструмента является возможность экспортировать один и тот же документ в форматы: HTML, CHM, PDF. Простой и понятный интерфейс сам подскажет, как быстро просмотреть документ в различных форматах и настроить его под вывод в эти форматы.

Любой проект в Dr.Explain вы можете создать с нуля или импортировать уже существующую документацию, например из формата MS Word, HTML или CHM-файла, и буквально за несколько минут создать из нее онлайн-помощь, файл справки в формате CHM, или документ в формате PDF.  

При создании руководства важно опираться на заранее составленный план. Дерево проекта в Dr.Explain поможет структурировать документ по вашему усмотрению. Вы можете добавлять, удалять перемещать разделы и переименовывать их. Для каждого раздела вы можете определить, в какой формат он будет экспортироваться. Также в работе удобно использовать статусы готовности разделов.

У программы свой собственный редактор, оптимизированный под работу со сложной документацией. Основные функции редактора вынесены в компактный тулбар. Это — управление стилем текста, форматирование абзацев, вставка ссылок, изображений, видео, таблиц и списков, а также вставка специальных объектов. Dr. Explain экономит время и силы своих пользователей. Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста и прибегают к очевидным решениям — «Ctrl+c», Ctrl+v». Dr.Explain предлагает решение по повторному использованию контента — текстовые переменные. Это решение экономит время, когда нужно много раз использовать один и тот же текст, особенно, который может периодически изменяться — например, версия документируемой системы.

Многие российские компании сталкиваются с тем, что руководство пользователя нужно писать согласно ГОСТ 19 и ГОСТ 34. Dr.Explain активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.

Часто техническим писателям при документировании пользовательского интерфейса приходится снабжать изображения пояснительными выносками. Для таких случаев программа поддерживает специальные графические объекты — аннотированные экраны. Чаще всего аннотируются скриншоты программ и страниц веб-сайтов. Уникальной особенностью Dr.Explain является автоматическая аннотация изображений, получаемых при захвате экранов с окнами программ или сайтов. Программа анализирует структуру окон и добавляет пояснительные выноски ко всем значимым элементам.

Кроме того, Dr.Explain позволяет нескольким авторам одновременно работать над проектом с использованием сервиса www.tiwri.com, учетную запись на котором можно создать бесплатно за пару минут. При внесении правок одним автором сервис блокирует редактируемые разделы проекта для изменения другими авторами.  По окончании редактирования изменения отправляются на сервер, и блокировка снимается. Так несколько человек могут одновременно работать над различными разделами проекта без риска помешать друг другу.  

Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.

Почему компании выбирают Dr.Explain для создания руководств пользователя

Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»

«Только программа Dr.Explain обладала всеми необходимыми возможностями. А главное — она давала простор для творчества. Можно было выбрать цветовую гамму, вид и форму служебных элементов, настраиваемые шаблоны. Это позволило мне сохранить стилевое единство документации и самой программы. Ну, и конечно, полуавтоматическая обработка материала существенно облегчает и ускоряет работу по созданию хелпа.

Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу».

Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке

---

Наталья Обухова, бизнес-аналитик компании CRM Expert

«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.

Через неделю справка была полностью готова. Конечно, если мы набивали ее «с нуля», за это время мы бы не успели. Мы просто конвертировали все бумажные инструкции во внутренний формат программ, изменили каталогизацию и организовали систему гиперссылок.

Сначала фаворитом выбора была другая система, но решающим фактором в пользу Dr.Explain стал возглас человека, выполняющего основную часть работы по переносу текста: «Вжух! И вся структура документа перенеслась в файл справки». Функция импорта в Dr.Explain отработала на ура и сэкономила кучу времени.

Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».

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

Прочитать полный кейс компании CRM Expert

---

Николай Вальковец, разработчик компании 2V

«Мы значительно сократили время работы техподдержки с новыми клиентами на этапе подключения. Раньше требовалось проводить онлайн презентации и видео конференции для новых клиентов, объясняя особенности программы. Сейчас же, один раз постаравшись максимально подробно всё описать, мы избавили себя и нашу техподдержку от этой работы. Нам импонирует простота программы и скорость работы. Можно быстро редактировать, добавить новые пункты в документацию, сохранить в формате HTML и выложить на сайт».

Прочитать кейс компании V2  

---

Подытожим

Создание и написание хорошей пользовательской документации — это труд, который требует много времени и усилий. Но если успешно справиться с задачей, можно навсегда получить лояльных и довольных клиентов. Не забывайте о том, что недовольство от некачественного руководства может быть спроецировано пользователем на сам продукт и повлиять на дальнейшие решения о его выборе. Пользовательская документация должна стать персональным и незаменимым помощником. Используя Dr. Explain, вы сможете быстро создать качественное руководство пользователя, которое будет помогать пользователям разбираться в продукте, а вам позволит сосредоточить свои силы на более важных задачах — разработке и продвижении программного продукта.

Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/

Успешных вам разработок!

Смотрите также

• Dr.Explain — инструмент для создания мобильной версии пользовательской документации к программным продуктам
• Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации

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

Приятного чтения.

Если перед вами стоит вопрос – нужно ли вашему продукту пользовательское руководство, то отвечу сразу – да, нужно. Почему? На это есть две причины:

1. Качественная документация повышает лояльность клиента и ценность продукта в целом.

Как это не странно, но люди до сих пор читают пользовательскую документацию. Конечно, не просто так, а когда сталкиваются с проблемой. И если с руководством все хорошо, то пользователь быстро найдет ответ на свой вопрос – это будет ещё один балл в копилку вашего проекта!

2. Руководство пользователя экономит время и силы техподдержки.

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

А теперь к советам!

Общие советы по созданию руководства пользователя

Прежде чем начинать писать руководство пользователя нужно ответить на несколько вопросов. — Для кого вы пишите? Кто будет пользоваться файлом справки? (ваша целевая аудитория)

— Где скорее всего пользователи будут прибегать к документации? (дома, на работе, в машине)

— Насколько объективно сложен для понимания продукт и как часто пользователь будет обращаться к документации?

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

(Для изложения лучше всего выбрать нейтрально-формальный стиль)

Структура руководства пользователя

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

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

В первом разделе расскажите общую информацию о продукте. Для чего создан проект и какие задачи он решает.

Во второй «главе» укажите основные элементы интерфейса. Клиент вряд ли сможет достичь своей цели в программе, если не будет знать для чего служат различные детали интерфейса. Объясните предназначение всех окон, кнопок и так далее.

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

В любом руководстве желательны разделы «Частые вопросы» и «Устранение типовых проблем». Расскажите о проблемах, с которыми часто сталкиваются клиенты и о путях их решения.

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

И последний «обязательный» раздел, которой точно должен быть в любой документации – «контактная информация». Данный раздел даст пользователю возможность связаться с разработчиком. Если руководство вдруг не закрывает потребность читателя, то он может обратиться в поддержку. Кроме того, клиент может дать совет, поделиться опытом или предложить выгодное вам сотрудничество.

Профессиональный совет: если вы хотите максимально облегчить ношу клиента при чтении документации создайте контекстно-зависимую справку. Что это такое?

Представьте, что вы работаете в программе для создания пользовательской документации. Открываете меню основных настроек и видите раздел «аннотирование экрана» Заходите в него, там показаны разные стили аннотации, тени, фон и так далее. Но что такое аннотация? Допустим вы не знаете — нажимаете кнопку F1 и перед вами открывается руководство именно на той странице, где рассказано об «аннотировании экрана»

Как ее сделать? Смотрите ниже.

Контент

И так, мы создали «каркас» нашей документации, но чтобы руководство стало полезным нужно наполнить её компетентной информацией.

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

1. Понятность.

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

2. Наглядность.

Добавляйте в руководство побольше графики и скриншотов с аннотациями. Читателю будет проще и приятнее решать проблему, если будет наглядно показано как это делать.

3. Видео.

Лучше один раз увидеть, чем сто раз услышать. Продемонстрируйте пользователю последовательность действий для достижения конкретной цели. Документация, содержащая видео вставки будет пользоваться большей популярностью, чем обычный текстовый документ.

Но как добавить в документацию видео? Смотрите ниже.

Больше советов!

Когда документация будет готова, чтобы она стала «полноценной» её нужно опубликовать. Иначе какой от неё толк, если клиент не может её прочитать. У «юзера» всегда должен быть доступ к документации, и не важно где он. Такую потребность легко закрывают три формата: HTML, PDF и CHM.

Создайте файл справки и загрузите его прямо в вашу программу в формате CHM. Таким образом, у пользователя будет возможность открыть документ, не выходя из программы. Не забудьте добавить элемент вызывающий руководство в меню программы.

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

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

Но помните, что после публикации документации, придется иногда её обновлять.

Инструменты

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

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

Dr.Explain – программа для создания руководств пользователя для ПО, web-сервисов и баз знаний.

Благодаря «доктору» вы сможете опубликовать и обновлять документацию в востребованных форматах (CHM; HTML; PDF; DOC), не выходя из программы.

В программе есть шаблоны документации, ведь по образцу работать проще.

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

Вы сможете создать контекстно-зависимую документацию, настроить визуальный стиль руководства, добавить в него видео и многое другое!

Какой можно сделать вывод

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

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

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

Спасибо за внимание!

Со всеми возможностями Dr.Explain можно ознакомиться здесь:

Почему пользователи не читают документацию или как можно улучшить руководство пользователя

Часть первая

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

Приятного чтения.

За долгое время работы над программой для написания этих самых «хелпов», наша команда рассмотрела и проанализировала множество сторонних проектов, руководители которых обращались к нам за помощью. Чаще всего с их стороны были вопросы о реализации тех или иных приемов в пользовательской документации к их продуктам. И на основе такого опыта мы сделали два вывода:

1) Документация востребована и ее читают.

2) Если ей не пользуются, то это происходит по следующим причинам:

«А где найти руководство»

• На сайте программы отсутствует ссылка на файл справки

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

• Документацию сложно найти

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

• Отсутствует «справка» в меню

  Решение простое: пробегитесь глазами по интерфейсу программы и попробуйте найти место для элементов управления, которые будут открывать файл-помощник.

• «F1 не работает!»

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

«Что-то не то с форматом»

• Формат документа не поддерживается

  Данная ошибка часто встречалась у клиентов, которые разрабатывали межплатформенные программы. Создавая файл справки, разработчики часто забывали, что его могут открывать не только пользователи «винды» и интегрировали справку с продуктом только в формате CHM. Этот формат отлично поддерживается Windows и изначально умеет просматривать CHM файлы. Но для других операционок CHM не является «родным», и ваш клиент замучается открывать его например на MacOS или Ubuntu.

• Формат документа не удобен для чтения на конкретном устройстве или в конкретной среде

  Казалось бы, универсальным решением универсальности документации являются HTML и CHM форматы. Имея доступ в интернет, пользовательскую документацию опубликованную на сайте можно открыть на любой платформе, а контекстно-зависимую справку просто нажав на кнопку F1.

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

  Решение простое – поставляйте ваш продукт вместе с документацией в формате PDF или разместите PDF файл на сайте, чтобы «мануал» можно было скачать на устройство. В таком случае у пользователя всегда будет под рукой локальная версия справки, к которой он сможет обратиться за помощью.

  «Навигационные проблемы»

• Отсутствует поиск по документации

  Техническая документация к продукту сама по себе подразумевает большое количество разделов и даже с хорошей и логичной структурой пользователю будет тяжело найти в ней нужную информацию. Здесь поможет «поиск» по документу. Но ведь что в PDF, что в CHM формате функция поиска реализована по умолчанию. Тогда почему здесь эта ошибка?

  Потому что разработчики часто забывают, про онлайн документацию, которая является набором разных HTML файлов. В ней браузер может найти конкретные фразы только на странице, открытой в данный момент. Для поиска по всем разделам документации не забудьте создать особый скрипт или используйте Google Site Search.

Вторая часть — https://habr.com/ru/post/659191/

P.S. Под технической документацией в данной статье я имею в виду только руководство пользователя.

Почему в наше время компы продают без инструкции по эксплуатации?

2 Ответы

Связанные вопросы