Users guide инструкция на русском языке

Инструкции, user manuals

Пользовательские инструкции, user manuals, руководства по эксплуатации электронной технике

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

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

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

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

📌 Руководство пользователя ещё называют инструкция пользователя, документация, хелп или юзер-гайд (user guide). Это справочная цифровая библиотека, по которой можно изучать программу. Руководство пользователя входит в состав технической документации и разрабатывается техническим писателем и продуктовой командой.

Документация продуктов бывает разной, как и сами продукты. У них отличаются цели и аудитории 👇

Виды руководств пользователя

⚙️ Пошаговое руководство или «Быстрый старт»

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

Картинка с сайта: weeek.net

Источник: Segnetics

⚙️ Справочное руководство

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

Картинка с сайта: weeek.net

Хелп WEEEK

⚙️ Руководство по устранению неисправностей

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

Картинка с сайта: weeek.net

Источник: ELTEX

⚙️ Руководство для администраторов

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

Картинка с сайта: weeek.net

Источник: VK WorkSpace

⚙️ API-документация

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

Картинка с сайта: weeek.net

Источник: REST API GitHub

Руководства такие разные, но у них много общего — структура, язык, подход к написанию. 

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

Как создать руководство пользователя. Опыт WEEEK

Технический писатель и автор раздела «Помощь» WEEEK Рукия Багаудин рассказала, как устроено наше руководство изнутри, и поделилась полезными инструментами, которые помогают вести и обновлять его. 

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

Шаг 1. Определение содержания

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

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

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

Картинка с сайта: weeek.net

Слева как раз содержание руководства: главные его части

Шаг 2. Структурирование материала

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

Здесь нужно расширить содержание сервиса. Как это сделать? Разбить составные части продукта на более мелкие — определить разделы и статьи, которые расскажут про каждый из них.

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

💡 При визуализации лучше дать каждому блоку свой цвет — это поможет  ориентироваться в структуре и видеть картину целиком:

Картинка с сайта: weeek.net

Построение схемы в FigJam

Картинка с сайта: weeek.net

Главное договориться о цветах визуализации!

Шаг 3. Написание и форматирование

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

Картинка с сайта: weeek.net

У нас структура текста документации создана в FigJam

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

Каждая колонка на Канбан-доске может относиться к разделам хелпа: 

Картинка с сайта: weeek.net

Структура на доске повторяет структуру в схеме. Но с доской проще работать

То же самое касается и самого написания статей.

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

Ответственный перемещает задачу по доске. Когда текст готов, то его переносят в колонку «На проверке» — и так далее. Это делает процесс работы прозрачным.

Картинка с сайта: weeek.net

Рукия Багаудин, технический писатель WEEEK 

Картинка с сайта: weeek.net

На Канбан-доске удобно декомпозировать большие задачи. Так можно повторить структуру руководства со схемы — все внутренние подразделы привязаны к родительскому. Они образуют одну сущность, будут храниться вместе и не потеряются:

Картинка с сайта: weeek.net

Глава руководства — задача. Статьи — подзадачи

Картинка с сайта: weeek.net

Шаг 4. Ревизия и корректура

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

Для этого тексты должна проверять продуктовая команда — продакт-менеджер, владелец продукта или отдел контента, при условии, что он погружен в продукт.

Шаг 5. Публикация и актуализация

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

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

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

Тезисы вместо всей статьи

Поговорим о User manual, что скрывает этот термин, звучащий по-русски как: «Руководство пользователя» и о том, что сложно в переводе этого типа документов.

Что для обывателя руководство пользователя? – Это большой буклет, в котором будут читаться два раздела: включение устройства и решение проблем таких как «зажевывание бумаги», «зависание телефона», «сбой настроек каналов». Остальные части в 80% игнорируются потребителями и для них перевод user manual это легко. Ведь есть тексты на английском и значит перевести это легко.

Что user manual для компании? – Это документ, без перевода которого, продукция не выпускается на рынок. И важно не только перевести грамотно, но и соблюдать требования ГОСТ. Из изменений последних шести лет важно отметить принятый в марте Технический регламент Таможенного Союза ТР ТС 010/2011, требующий предупреждать в руководстве пользователя о том, проверялось ли устройства на испытаниях и оценивалось ли на опасность.

Что значит перевод user manual для переводчика? – Долгая, титаническая работа с документом большого объёма, который может не иметь адекватного источника. Это связано с тем, что зачастую термины в английском и немецком тексты будут отличаться друг от друга, так как изначально были переведены с китайского и не скорректированы и не приведены в единый вид.

И что же такое заказ на перевод руководства пользователя для агентства переводов? – Задача, требующая привлечения нескольких переводчиков, между которыми делится документ, которую клиент не редко требует выполнить в течение дня, что не совсем реально. И не всегда клиентом предоставляется единая терминологическая база. Тогда на плечи редакторов возлагается почётная миссия унификации лексики. И не будем забывать о необходимости оформления документов по ГОСТу с универсальными изображениями и символами.

Подытожим, перевод user manual – это сложная и увлекательная задача, которая решается агентством с помощью:

· подбора команды переводчиков, редакторов, в исключительных случаях консультантов;

· единой базы терминов, предоставленных заказчиком;

· знания ГОСТ, регулирующих перевод.

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

281,358,316,255