Создать руководство по эксплуатации

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

Компания Серконс оказывает услуги в сфере разработки руководства по эксплуатации

Зачем и для кого создается документ?

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

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

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

Особенности создания и оформления

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

Руководство может создаваться на подготовительном этапе, как на отдельный продукт, так и на группу однотипных моделей с едиными данными и правилами. Процесс его оформления не отличается от конструкторско-технической документации и регулируется положениями национальных стандартов ГOCТ 2.601-2013 и ГOCТ 2.105-95.

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

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

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

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

Требования к созданию руководства по эксплуатации

Основным документом, регламентирующим создание эксплуатационной инструкции, является стандарт ЕСКД, точнее требования, входящих в него:

• ГОСТ 2.610-2013;
• ГОСТ 2.601-2013;
• ТР ТС 010/2011;
• ТР ТС 016/2011.

При производстве устройств узконаправленного стандарта (насосов, арматуры) РЭ составляется с учетом Правил безопасности для промышленного оборудования.

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

Кто разработчик?

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

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

Отправить заявку на разработку руководства по эксплуатации

Вас может заинтересовать

Отзывы

ООО «ИЛОТ»

Уважаемый Андрей Алексеевич

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

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

Все работы были выполнены качественно и в ожидаемые сроки.

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

Руководитель отдела логистики ВЭД ООО «ИЛОТ», Эстеркин К.В.

ООО «ПСК-Реконструкция»

Благодарственное письмо

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

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

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

Генеральный директор

М.А. Ахиллес

ООО «Галактика»

Настоящим выражаем свою благодарность ГК «Серконс», который является нашим основным партнером в сфере сертификации продукции с 2018 года.

В перечень услуг, оказываемых нам ГК «Серконс», входит оформление Сертификатов Соответствия Таможенного Союза и Деклараций Соответствия Таможенного Союза.

Отдельно хочется отметить профессионализм работы менеджеров по сертификации продукции Мельникова Георгия Викторовича и Телицыну Евгению Николаевну – их ответственное отношение к каждому запросу, высокую скорость обработки запросов и оперативное разрешение возникающих вопросов.

Благодарим за сотрудничество и надеемся на эффективное взаимодействие в будущем!

Генеральный директор

И.В. Липский

ООО «МорНефтеГазСтрой»

Уважаемая Яна Александровна!

Компания ООО «МорНефтеГазСтрой» выражает глубокую и искреннею благодарность ООО «СЗРЦ ПБ» за профессиональный подход к своей работе. Квалификация и опыт специалистов, которые всегда на связи, позволили оперативно решить возникшие вопросы в кратчайшие сроки и выполнить работу в соответствии со всеми нормами и правилами.

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

Генеральный директор

Тижук М.М.

ООО «ВолгоградНИПИморнефть»

Уважаемый Алексей Петрович,

Выражаем Вам благодарность за качественно выполненную услугу по разработке специальных технических условий на проектирование и строительство объекта в части обеспечения пожарной безопасности блока хранения и налива СУГ по объекту:

«Освоение месторождения D33 с объектами инфраструктуры. Первый этап освоения. Реконструкция трубопровода товарной нефти НСП «Романово» – ООО «ЛУКОЙЛ-КНТ».

Все работы были выполнены качественно и в запланированные сроки.

Особенно хотелось бы отметить менеджера Дарью Олеговну Мастерских и экспертов Митичкина Александра Алексеевича и Черникова Евгения Михайловича за их профессионализм и оперативную работу.

Мы можем рекомендовать ГК «Серконс» как надежного профессионального партнёра и надеемся на дальнейшее взаимовыгодное сотрудничество.

Первый зам. генерального директора – Директор по развитию бизнеса – Главный инженер

А.В. Скурлатов

ООО «Мастер РУФ»

Благодарственное письмо.

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

Все работы выполнены качественно и в ожидаемые сроки. В особенности хотелось бы отметить менеджера Родригес Изабель Владиславовну – за профессионализм и оперативную работу.

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

С уважением,

Генеральный директор

И.Н. Малахов

Золотой медвежонок 2020

Благодарность

Оргкомитет

XI Национальной премии в сфере товаров и услуг для детей «Золотой медвежонок – 2020» выражает глубокую признательность за экспертную поддержку и профессиональный подход к работе в Экспертном совете Техническому директору испытательного центра ГК «Серконс» Прокопьевой Ирине Александровне.

Ваш экспертный опыт – ценный вклад в развитие премии.

С нетерпением ждём Вашего участия в XII национальной премии «Золотой Медвежонок – 2021».

Председатель оргкомитета

А.В. Цицулина

ООО «Газэнергосеть розница»

Благодарственное письмо

Уважаемый Алексей Петрович!

ООО «ГЭС розница» выражает благодарность ГК «Серконс» за выполненную работу по проведению специальной оценки условий труда (СОУТ) в нашей компании в 2020 году.

Благодаря компетентности и высокому уровню профессионализма специалистов ГК «Серконс» услуги по проведению СОУТ были выполнены качественно и своевременно.

Коллектив ООО «ГЭС розница» желает Вашей команде успехов во всех начинаниях и достижения всех поставленных целей. Надеемся в будущем на взаимовыгодное сотрудничество с Вашей организацией!

С уважением,

Заместитель генерального директора –

Главный инженер ООО «ГЭС розница»

С.А. Карабашев

ФКП «Анозис»

Уважаемый Алексей Петрович!

ФКП «Анозит» выражает благодарность экспертной организации ГК «Серконс» за качественно проведенное техническое диагностирование и экспертизу промышленной безопасности на производственных площадках нашего предприятия.

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

Особенно хотим поблагодарить специалиста по промышленной безопасности Баздрова Олега Андреевича, инженеров Фёдорова Алексея Владимировича и Безуглова Антона Юрьевича, а также руководителя отдела лицензирования и регистрации ОПО – Юзвенко Романа Евгеньевича, за корректно выполненную работу и ответственный подход к выполнению поставленных задач.

Главный инженер

О.Г. Бенцлер

АО «Раменский приборостроительный завод»

Уважаемый Алексей Петрович!

АО «Раменский приборостроительный завод» выражает благодарность и признательность лично Вам и всему коллективу ГК «Серконс» за оперативное и качественное проведение специальной оценки условий труда на нашем предприятии.

На всех этапах сотрудники демонстрировали профессиональный подход к делу и высокую квалификацию в области проведения СОУТ. Особую признательность хочется выразить эксперту по СОУТ Ли Татьяне Владимировне за качественное и оперативное выполнение работ по СОУТ, широкий спектр профессиональных знаний и непосредственную вовлеченность в рабочий процесс.

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

За время работы мы убедились, что ГК «Серконс» является надежным партнером. С уверенностью можем сказать, что сделали правильный выбор, приняв решение о сотрудничестве с Вами.

Мы рекомендуем компанию КГ «Серконс» как надежного партнера, работающего на высоком профессиональном уровне.

Главный инженер

С.И. Пономарев

ГБК РО «МШОР №8 им. В.В. Понедельника» Ростов-на-Дону

Уважаемый Андрей Алексеевич!

ГБУ РО «СШОР № 8» пользуется услугами ООО «Серконс» по сертификации спортивных объектов, находящихся в оперативном управлении нашего учреждения с 2016 года.

За это время с помощью команды ООО «Серконс» г. Ростова-на-Дону произведена сертификация, а также продление сроков действия сертификатов на спортивные объекты в г. Ростове-на-Дону:

Дворец спорта, открытый футбольный стадион на 1500 зрительских мест, водно-спортивная база «Зелёный остров».

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

Мы и дальше надеемся на сотрудничество с ООО «Серконс» и будем рекомендовать всем Вашу компанию как прекрасно организованную и авторитетную организацию.

С уважением,

И.о. директора А.А. Пивоваров

ООО «Хабаровскремпроект»

Уважаемая Яна Александровна!

ООО «ХАБАРОВСКРЕМПРОЕКТ» выражает благодарность компании ООО «СЗРЦ ПБ» за качественно выполненную услугу по разработке и согласованию специальных технических условий в МЧС России ив Министерстве строительства и жилищного-коммунального хозяйства Российской Федерации.

Так же хотим особо отметить менеджера Синявского Дмитрия Юрьевича и руководителя Отдела независимой оценки риска и экспертизы пожарной безопасности Рементова Андрея Николаевича за профессионализм и качественное исполнение работы.

Мы можем рекомендовать компанию ООО «СЗРЦ ПБ», как хорошо организованную, профессиональную команду, и рады, что приняли решение о сотрудничестве с Вами.

Также на сегодняшний день прорабатываем возможность сотрудничества с Вашей компанией на разработку и прохождение СТУ по планируемому проекту Гостиничный комплекс по пер. Некрасовский 30 в г. Владивостоке.

Генеральный директор

ООО «Хабаровскремпроект»                                                                                                                                                               А.А. Радыгин

АО «Евраз НТМК»

Уважаемая Яна Александровна!

АО «Евраз НТМК» выражает благодарность компании ООО «СЗРЦ ПБ» за качественно выполняемые услуги по разработке специальных технических условий.

Мы можем рекомендовать компанию ООО «СЗРЦ ПБ», как хорошо организованную профессиональную команду, выражаем уверенность в сохранении сложившихся отношений и надеемся на дальнейшее плодотворное сотрудничество.

Начальник УКС И.Е. Хаятов

ООО «АББ»

Уважаемый Андрей Алексеевич!

Благодарим ООО «Серконс» в лице Увайской Людмилы Леонидовны и ее команды специалистов за организацию и проведение работ по сертификации, а также декларированию соответствия большого перечня продукции ООО «АББ», подпадающей под действие Технических регламентов Таможенного союза ТР ТС 004/2011 «О безопасности низковольтного оборудования» и ТР ТС 020 «Электромагнитная совместимость технических средств», а также за содействие по другим направлениям нашего сотрудничества с ООО «Серконс», которое длится с 2011 года.

Работа Ваших Специалистов важна и способствует процессу своевременного выпуска продукции ООО «АББ» в обращение на территории Таможенного союза.

Рассчитываем на продолжение стабильного, долгосрочного сотрудничества с ООО «Серконс».

Старший инженер по технической поддержке и сертификации продукции Е.Н. Герасимович

ООО «Магистраль»

Уважаемый Алексей Петрович!

ООО «Магистраль» выражает благодарность ГК «Серконс» за профессиональное оказание услуги по негосударственной экспертизе проектной документации и результатов инженерных изысканий.

За время нашего сотрудничества хотелось бы отметить компетентность менеджера Шуракова Сергея Сергеевича и его способность качественно и быстро решать вопросы.

Нам доставило большое удовольствие сотрудничество с ГК «Серконс».

Мы рекомендуем данную компанию в качестве профессионального партнера и надеемся на дальнейшее сотрудничество.

Генеральный директор ООО «Магистраль» Г.М. Макаршин.

ООО «Старт-Строй»

Генеральному директору ООО «Серконс» Григорьеву А.А.

ООО «Старт-Строй» выражает слова искренней благодарности руководству и сотрудникам ООО «Серконс» за проведение экспертизы проектной документации строительства объекта: «Многоквартирный жилой дом №4 по адресу: г. Н. Новгород, Советский район, у дер. Кузнечиха».

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

Желаем Вам профессионального роста и успехов в бизнесе.

Генеральный директор Поваляев А.В.

ГРУППА КОМПАНИЙ «ИСТА»

Благодарственное письмо

Компания ООО «ИСТА-Техника» благодарит коллектив филиала органа по сертификации «СЕРКОНС» в г. Санкт-Петербург за эффективную работу специалистов, оперативность выполнения работ по обязательной сертификации и декларированиюпродукции и внимательное отношение к Заказчику.

Квалифицированные менеджеры и их ассистенты — Лукконен Александра Владимировна, Васильевская Дарья Алексеевна, Савченко Анастасия Николаевна, а также экспертный состав испытательных лабораторий «СЗРЦ ПБ» и «НОРМАТЕСТ», продемонстрировали глубокое знание специфики продукции в области пожарной безопасности.

Компания ООО «ИСТА-Техника» характеризует филиал органа по сертификации «СЕРКОНС» в г. Санкт-Петербург как профессионального и надежного партнера в области обязательного подтверждения соответствия продукции требованиям технического регламента Евразийского экономического союза «О требованиях к cредствам обеспечения пожарной безопасности и пожаротушения» ТР ЕАЭС 043/2017.

С уважением,

Директор центра пожарной безопасности,

Павлов А.П.

Смотреть все

Среди наших клиентов

Оформить руководство по эксплуатации необходимо, следуя требованиям национального стандарта ГОСТ 2.601-2019. В нём можно найти очень много информации об эксплуатационных документах в целом и руководстве по эксплуатации в частности.

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

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

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

Основные принципы оформления содержания руководства по эксплуатации

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

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

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

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

Если оформляется руководство по эксплуатации на изделие, которое требует повышенной осторожности при использовании, то на титульном листе документа следует сделать соответствующую надпись: например, «ВНИМАНИЕ! ОСОБАЯ ОСТОРОЖНОСТЬ!».

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

Основные принципы технического оформления руководства по эксплуатации

В национальном стандарте ГОСТ Р 2.601-2019 в подразделе 8.2 можно найти подробные требования к техническому оформлению руководства по эксплуатации, если оно разрабатывается в бумажном виде.

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

При оформлении руководства по эксплуатации на бумажном носителе следует использовать листы А4 согласно ГОСТ 2.301. Страницу документа нужно поделить на следующие зоны:

• информационная зона с технической информацией;
• верхний колонтитул – 1-2 строчки;
• нижний колонтитул – 2-3 строчки.

Если заказчик не выдвинул требования по качеству бумаги, формату, переплёту и других технических особенностей, то их устанавливает изготовитель оборудования.

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

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

Была ли эта статья полезной?

Писать руководство пользователя по шаблону. Удобно? Удобно

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

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

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

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

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

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

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

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

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

• Руководство пользователя программного обеспечения.

• Руководство пользователя web-сервиса.

• Корпоративная база знаний компании.

В чем удобство создания руководства пользователя по образцу

Вы бережете своё время.

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

Вы сосредотачиваете внимание на вашей программе, а не на создании файл-справки

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

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

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

 Адаптация шаблонов и образцов под ваш проект.

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

О шаблонах

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

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

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

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

Особые случаи. Здесь нужно рассказать пользователю про то, какие трудности могут возникнуть и как их решить, выделить часто задаваемые вопросы и дать на них самый доступный ответ. Подразделы: «FAQ» и «Устранение типовых проблем»

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

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

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

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

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

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

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 можно ознакомиться здесь:

Руководство по эксплуатации (РЭ) – это технический документ, включающий в себя сведения о конструктивных параметрах продукции, их составных элементах, принципе действия и технике безопасности во время использования и ремонта.

• Требования к руководству по эксплуатации
• Важные правила
• Кому может потребоваться руководство по эксплуатации?
• Какими ГОСТ и законами регламентируется порядок оформления документа?
• Каким должно быть содержание руководства по эксплуатации?
• Что может быть дополнительно?
• Как правильно оформить?
• Стиль оформления

Требования к руководству по эксплуатации

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

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

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

Важные правила

Составление РЭ проводится в соответствии с определенными правилами:

• Цель документа – разъяснение. Потребитель с помощью него обеспечивается всей необходимой информацией по использованию продукции;
• Вся представленная информация должна соответствовать остальной технической документации;
• Руководство должно полноценно отражать принципы работы и эксплуатации данного изделия или продукции в целом;
• Вся информация не должна противоречить государственным стандартам и существующим техническим регламентам;
• Язык написания документа должен быть простым, понятным для всех, кто планирует эксплуатировать продукцию.

Кому может потребоваться руководство по эксплуатации?

Документ может быть необходим и быть полезен для:

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

Какими ГОСТ и законами регламентируется порядок оформления документа?

Порядок оформления РЭ определен рядом нормативно-правовых документов и рекомендаций стандартов ЕСКД:

• ГОСТ 2.610-2006 – отражены общая система и правила тех. документов;
• ГОСТ 2.105-95 – отражены правила по тексту технической документации;
• ГОСТ 2.601-95 – указаны требования по оформлению РЭ;
• Также существуют требования, которые регламентируются Таможенным союзом: ТР ТС 016/2011, ТР ТС 010/2011 и другие.
• Для узконаправленной продукции оформление руководства по эксплуатации может еще регламентироваться дополнительными нормативами, например, Правилами безопасности оборудования.

Каким должно быть содержание руководства по эксплуатации?

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

1. Вводная часть;
2. Оглавление;
3. Подробное описание продукта, устройства или механизма;
4. Комплектность;
5. Подробное описание и условия его использования;
6. Монтаж;
7. Сервисное обслуживание, ремонт – указание возможных неполадок и способы их устранения;
8. Применяемые к условию стандарты, требования и нормы безопасности;
9. Гарантии производителя;
10. Правила по хранению и транспортировке;
11. Правила утилизации;
12. Предметный указатель (глоссарий).

Что может быть дополнительно?

Дополнительно РЭ часто содержит:

• FAQ (часто задаваемые вопросы) и ответы на них;
• Ссылки на дополнительную информацию по сфере применения товара;
• Ссылки на обучающее видео;
• Популярные подсказки;
• Краткую аннотацию в начале каждого крупного раздела.

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

Как правильно оформить?

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

Стиль оформления

Стиль оформления текста – деловой, нейтрально-формальный, без использования стилистические окрашенных слов, чтобы не отвлекать пользователей от сути документа. Важно не дублировать информацию, писать кратко и по сути. Последовательность данных должна походить на последовательность действий пользователя. Вежливые обороты («пожалуйста») не используются, только повелительное наклонение («возьмите», «соберите» и т.д.). Информация должна быть максимально структурирована, с использованием списков и нумерации. Внешний вид документа тоже должен быть продуман. Это может быть корпоративный шаблон, цветовая схема или специально созданный дизайн. Восприятие красиво оформленного РЭ может быть спроецировано на изделие и повлиять на решение его закупки и использования.

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

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

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

Вот здесь и начинается все самое интересное…

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

Удобство и простота использования товара всегда являлись весомыми «рычагами» влияния на принятие ЦА решения о покупке.

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

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

Написание качественного руководства по эксплуатации товара — это целое искусство. Давайте приоткроем занавес и заглянем «за кулисы» его создания.

Итак, на что же стоит обратить внимание при составлении руководства по эксплуатации, которое будет «работать» на продажи?

Детализация

Конкретика и степень детализации — те параметры, которые определяются согласно уровню подготовленности ЦА. Здесь выбирается оптимальный баланс, ориентированный на потенциального покупателя.

Например:

После нажатия ____ появляется приветственное окно.

После нажатия ____ в ____ углу клавиатуры на экране появляется приветственное окно с надписью «____».

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

После нажатия пальцем клавиши ____ в правом верхнем углу клавиатуры на экране появляется приветственное окно с темно-синей надписью «____», расположенной посередине.

Структурирование

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

Сравните:

1. Вставьте диск в дисковод.
2. В появившемся окне нажмите ____.
3. Выберите пункт меню ____.

и

Вставьте диск в дисковод, затем в появившемся окне нажмите ____, и уже после этого выберите пункт меню ____.

В первом варианте мы видим пошаговое структурирование информации. Четко, легко и понятно. Иначе выглядит и воспринимается второй вариант — он более «тяжеловесный».

Позитив и корректность

Думаете, это не важно? Ошибаетесь! Для позитивного результата нужно мыслить позитивно и говорить позитивно посредством текста с ЦА (да простят нас ярые противники тавтологии).

Никто не любит хамства и унылости. Поэтому настраивайте деликатно и очень корректно потенциальных покупателей ТОЛЬКО на позитив.

Вот как это выглядит на практике:

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

или

Достаньте монитор из коробки и освободите от упаковки. Постарайтесь в процессе его не уронить и не разбить.

НЕТ трем «С»: сокращениям, синонимам и сомнениям

При составлении инструкции по использованию товара желательно избегать любой «интонационной неуверенности». Смело вычеркивайте различные «пожалуй, наверное, возможно».

Сокращения допустимы лишь в том случае, если в самом начале руководства была приведена полная формулировка, возле которой указывалась ее «сжатая форма»:

Транспортная компания (ТК) отвечает ____.

Многофункциональное устройство (МФУ) работает ____.

Операционная система (ОС) запускается ____.

Неприемлемо использование синонимов и жаргонов. Не нужно «красоваться» своей эрудицией и запутывать пользователей разной терминологией.

Если речь идет, например, о мобильном телефоне, то не стоит применять по тексту инструкции такие слова, как «мобильник», «мобила», «телефонный аппарат», «сотовый телефон» и т.д.

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

Да здравствует повелительное наклонение!

Используйте повелительное наклонение — побуждайте пользователей к действию (призывайте, советуйте, предупреждайте, запрещайте).

Сравните:

Для включения телефона нужно нажать на ____.

Кнопка ____ отвечает за включение телефона.

или

Нажмите ____, чтобы включить телефон.

Включите телефон с помощью кнопки ____.

Последний штрих

Хуже всего, если человек ввиду «путаного руководства» не смог понять, как пользоваться товаром, и отказался от его приобретения. Поэтому…

После того, как готовая инструкция закрепилась на «экранном листе» монитора нажатием кнопки «сохранить», не лишним будет проверить — понятна ли она вашей ЦА.

Так работает наша Студия!

Мы не занимаемся написанием «словесных полотен» с простым описанием ряда необходимых действий, а разрабатываем четкие, логичные и наглядные руководства.

Руководства по использованию, которые стимулируют пользователей к покупке.