Руководство пользователя нужно всем IT-продуктам — новым и давно выпущенным. Куда нажать, чтобы всё заработало? Как пользоваться программой после масштабного обновления? Знакомые вопросы для любого юзера.
Рассказываем, каким бывает руководство пользователя, и как написать свой юзер-гайд по опыту WEEEK.
Что такое руководство пользователя
📌 Руководство пользователя ещё называют инструкция пользователя, документация, хелп или юзер-гайд (user guide). Это справочная цифровая библиотека, по которой можно изучать программу. Руководство пользователя входит в состав технической документации и разрабатывается техническим писателем и продуктовой командой.
Документация продуктов бывает разной, как и сами продукты. У них отличаются цели и аудитории 👇
Виды руководств пользователя
⚙️ Пошаговое руководство или «Быстрый старт»
Общее описание продукта — рассказывает, как им пользоваться
-
Для кого. Для тех, кто делает первые шаги в использовании продукта -
Цель и польза. Знакомство с основными функциями продукта, чтобы дальше использовать его самостоятельно -
Форматы публикации. Текст и видеотуториалы
Источник: Segnetics
⚙️ Справочное руководство
Ещё его называют базой знаний пользователя, справкой, документацией или «хелпом» — как помощь. В нём подробно описываются функции и возможности продукта.
-
Для кого. Для всех пользователей -
Цель и польза. В справочном руководстве описывают все возможности продукта и то, как им пользоваться -
Форматы публикации. Текст и иллюстрации — например, скриншоты, дополнительно видео или gif
Хелп WEEEK
⚙️ Руководство по устранению неисправностей
Это документ с перечислением всевозможных проблем, которые могут возникнуть при использовании продукта, и их решений.
-
Для кого. Для всех, кто уже имеет опыт использования продукта -
Цель и польза. Помочь пользователям самостоятельно и в кратчайшие сроки решать проблемы, возникшие во время использования продукта -
Форматы публикации. Текст и видеотуториалы
Источник: ELTEX
⚙️ Руководство для администраторов
Вспомогательный документ, который рассказывает о работе и обязанностях администратора, политике безопасности, общих принципах и работе продукта.
-
Для кого. Для администраторов компаний -
Цель и польза. Руководство помогает правильно управлять учётными записями других пользователей, выдавать им доступы к данным, помогать решать проблемы внутри продукта -
Форматы публикации. Текст
Источник: VK WorkSpace
⚙️ API-документация
API — если очень просто — правила, по которым различные программы общаются между собой и обмениваются данными. Чтобы всё происходило без ошибок, нужна соответствующая документация.
-
Для кого. Для внутреннего использования с фокусом на потребностях разработчиков -
Цель и польза. API-документация нужна для успешной интеграции API в проекты и полноценного использования его функций внутри системы -
Форматы публикации. Текст
Источник: REST API GitHub
Руководства такие разные, но у них много общего — структура, язык, подход к написанию.
Поэтому мы подготовили пошаговую инструкцию, как подготовить руководство пользователя и на что обратить внимание в процессе.
Как создать руководство пользователя. Опыт WEEEK
Технический писатель и автор раздела «Помощь» WEEEK Рукия Багаудин рассказала, как устроено наше руководство изнутри, и поделилась полезными инструментами, которые помогают вести и обновлять его.
Уложили ответы Рукии в пять шагов, на которые ты можешь опираться при создании собственного руководства пользователя.
Шаг 1. Определение содержания
Хелп должен последовательно рассказать о функциях и особенностях продукта. Чтобы понять, какое выстроить содержание, надо определить ключевые части продукта. На них будет основана вся дальнейшая структура документации.
К примеру, руководство пользователя в WEEEK содержит подробную информацию о пяти главных сервисах: Задачах, Базе знаний, CRM, Пользователях и Аналитике.
Определять содержание нужно в связке с продуктовой командой — с продакт-менеджером или с владельцем продукта. С таким подходом получится описать продукт так, чтобы пользователи поняли, как его использовать.
Слева как раз содержание руководства: главные его части
Наш хелп — справочное руководство пользователя. Мы пишем его вместе с разработчиками и продуктовой командой: они обладают практической информацией, без которой наш хелп был бы просто теорией. Советую перед определением содержания, подготовкой структуры и прочих нюансов изучить похожие продукты. Посмотри, что и как они подсвечивают в своих хелпах и выдели аналогичные топики, которые можно взять для себя. Например, мы в WEEEK изучали хелпы Notion, Trello и Asana
Наш хелп тут
Шаг 2. Структурирование материала
Даже базовое содержание будущей документации — большая сущность. Чтобы обработать эту информацию, лучше использовать визуализацию — например, построить схему в FigJam.
Здесь нужно расширить содержание сервиса. Как это сделать? Разбить составные части продукта на более мелкие — определить разделы и статьи, которые расскажут про каждый из них.
Визуализировать структуру руководства пользователя удобно в виде дерева или ментальной карты — по нисходящей от главной части продукта к его составным частям.
💡 При визуализации лучше дать каждому блоку свой цвет — это поможет ориентироваться в структуре и видеть картину целиком:
Построение схемы в FigJam
Главное договориться о цветах визуализации!
Шаг 3. Написание и форматирование
Написание статей можно поставить на поток. Достаточно подготовить шаблон и собирать тексты как конструктор:
У нас структура текста документации создана в FigJam
Следующая задача — начать писать статьи. Для этого нужно продублировать структуру схемы из FigJam на Канбан-доске. Так тексты превратятся в задачи и будет проще выстроить зависимости, назначить ответственных и соблюдать дедлайны.
Каждая колонка на Канбан-доске может относиться к разделам хелпа:
Структура на доске повторяет структуру в схеме. Но с доской проще работать
То же самое касается и самого написания статей.
Только под процессы написания надо создавать отдельную доску, чтобы на ней можно было управлять этапами. К примеру, доску «Пишем хелп». Колонки здесь соответствуют этапам работы: «К работе», «В работе», «На проверке» и «К публикации».
Ответственный перемещает задачу по доске. Когда текст готов, то его переносят в колонку «На проверке» — и так далее. Это делает процесс работы прозрачным.
Мы используем итеративную систему: написали статью, опубликовали её — статус у карточки на Канбане поменялся. При необходимости можно обратно вернуть её в работу. Каждая карточка привязывается к определённой статье. Ещё в карточках хранится вся информация о текстах — кто автор, ТЗ, прочие комментарии, когда дедлайн, какой приоритет и так далее
Наш хелп
Рукия Багаудин, технический писатель WEEEK
На Канбан-доске удобно декомпозировать большие задачи. Так можно повторить структуру руководства со схемы — все внутренние подразделы привязаны к родительскому. Они образуют одну сущность, будут храниться вместе и не потеряются:
Глава руководства — задача. Статьи — подзадачи
Визуализация структуры хелпа поможет планировать и приоритизировать задачи, а ещё ориентироваться, какие статьи нуждаются в актуализации. Важно: структура не должна состоять из случайных статей, а соответствовать общей стратегии продукта
Наш хелп
Шаг 4. Ревизия и корректура
Без продуктовой ревизии и фидбека пользователей руководство останется теорией. Есть нюансы и фичи, которых технический писатель может не знать, не сразу заметить или неправильно раскрыть.
Для этого тексты должна проверять продуктовая команда — продакт-менеджер, владелец продукта или отдел контента, при условии, что он погружен в продукт.
Практические кейсы я получаю от директора по продукту WEEEK Инги Скерсь. Потому что об одной и той же вещи можно рассказать по-разному — это касается как изначального назначения, так и функций. Наш СЕО Иван Мараховка проводит свою аналитику, собирает вопросы от пользователей сервиса напрямую или от нашей AI-помощницы Вики, у которой пользователи спрашивают, как и что работает. Весь этот фидбек и информация добавляется в структуру хелпа и используется для написания новых статей
Наш хелп
Шаг 5. Публикация и актуализация
IT-продукты обновляются — вслед обновляется и руководство пользователя. Работы у команды будет не меньше, чем в начале создания документации: собрать обновления, найти статьи, в которых нужно изменить информацию, вновь подготовить текст и иллюстрации и опубликовать новый материал.
Чтобы это не превратилось в бессистемные телодвижения и бесконечный поток текстов, важно выработать процесс, по которому будет обновляться документация.
Вот два инструмента, которые могут упорядочить работу над актуализацией:
-
Один источник информации про обновления. Это может быть общий документ в корпоративной базе знаний или отдельный чат -
Система приоритизации, выработанная вместе с продуктовой командой. Не получится обновлять все тексты разом, и будут обновления, о которых надо написать в первую очередь. Решить, что сейчас в приоритете, можно только с продакт-менеджером или владельцем продукта
Когда для хелпа пишется много статей, надо держать в голове мысль, что в какой-то момент их придётся актуализировать. Советую собирать все продуктовые обновления в одном месте, доступном для всей команды — так все будут в курсе актуальной информации про новые фичи. К примеру, это может быть отдельный чат
Наш хелп
Тезисы вместо всей статьи
-
Руководство пользователя — справочный документ для пользователей IT-продуктов или других систем -
Руководство пользователя нужно создавать в связке с продуктовой командой — продакт-менеджером или владельцем продукта. Иначе документация превратится в бесполезный набор текстов -
Для оформления содержания и создания будущей структуры используй визуализацию — ментальная карта отлично подойдёт для этого -
Для написания руководства удобно использовать Канбан-доски — на них можно повторить всю структуру и управлять процессом создания текстов -
Для актуализации руководства пользователей лучше снова привлечь продуктовую команду — тех, кто лучше понимает требования пользователей и знает, о каких обновлениях важно рассказать в первую очередь
Инструкции, user manuals
ГлавнаяИнструкции, user manuals
Пользовательские инструкции, user manuals, руководства по эксплуатации электронной технике
Представляем вам архив пользовательских инструкций, user manuals, руководств по эксплуатации телефонов, бытовой аудио и видео техники, фототехники и др. электронной техники на русском языке. В архиве около 3000 user manuals доступных для закачки. Вы можете осуществлять поиск пользовательских инструкций по эксплуатации электронной техники по производителю или категории электронной техники. User manuals представлены в виде doc или pdf файлов упакованных в архивы.
Категории
- Blu-Ray проигрыватели(7)
- CD-проигрыватели(30)
- DVD-проигрыватели(911)
- FM-трансмиттер(13)
- GPS навигаторы и приемники(5)
- Авто CD/DVD-чейнджеры(27)
- Авто GPS навигаторы(99)
- Автоакустика(218)
- Автовидеорегистраторы(12)
- Автомагнитолы(1095)
- Автомобильное видео(26)
- Автоответчики(2)
- Автосигнализации(285)
- Автоусилители(96)
- Акустика(196)
- Аэрогрили(16)
- Беспроводные гарнитуры(2)
- Блендеры(64)
- Варочные панели(420)
- Вентиляторы(71)
- Весы(45)
- Видеокамеры(714)
- Видеомагнитофоны/видеоплееры(137)
- Водонагреватели(14)
- Воздухоочистители(8)
- Вытяжки(181)
- Диктофоны(47)
- Домашние кинотеатры(312)
- Духовые шкафы(384)
- Игровые приставки(7)
- Измельчитель(4)
- Кассетные деки(5)
- Кондиционеры(351)
- Кофеварки(139)
- Кофемолки(17)
- Кухонные комбайны(50)
- Магнитолы(204)
- Машинки для стрижки(24)
- Микроволновые печи(572)
- Миксеры(31)
- Морозильные камеры(55)
- Музыкальные центры(516)
- Мясорубки(31)
- Очистители воздуха(9)
- Пароварки(31)
- Планшеты(3)
- Плееры(421)
- Плиты(255)
- Посудомоечные машины(171)
- Проводные телефоны(72)
- Проекторы(41)
- Пылесосы(250)
- Радиоприемники(42)
- Радиостанции(40)
- Радиотелефоны(209)
- Ресиверы и усилители(154)
- Ростеры(3)
- Синтезаторы/фортепиано(109)
- Скороварки(1)
- Соковыжималки(55)
- Сотовые телефоны(1258)
- Спутниковые ресиверы(16)
- Стайлеры(36)
- Стиральные машины(1099)
- Сушильные машины(25)
- Телевизоры(1995)
- Термопоты(4)
- Тостеры(37)
- Увлажнители воздуха(18)
- Универсальные резки(5)
- Утюги(115)
- Факсы(157)
- Фены(73)
- Фотоаппараты(1041)
- Фоторамки(25)
- Фритюрницы(8)
- Хлебопечки(19)
- Холодильники(602)
- Чайники(120)
- Часы(57)
- Швейные машинки(180)
- Электрические печи(5)
- Электробритвы(89)
- Электронные книги(4)
- Электрообогреватели(111)
- Эпиляторы(6)
Производитель
- Acer(8)
- AEG(6)
- Aiwa(127)
- Akai(244)
- Alcatel(22)
- Alligator(55)
- Alpine(66)
- Apacer(15)
- Apple(5)
- APS(20)
- Arcam(21)
- Ardo(45)
- Ariston(153)
- Asus(9)
- Aurora(11)
- BB-mobile(6)
- BBK(461)
- Beko(83)
- Benefon(6)
- BenQ(13)
- BenQ-Siemens(13)
- Bernina(34)
- Binatone(4)
- Blaupunkt(40)
- Bork(235)
- Bosch(339)
- Braun(147)
- Brother(99)
- Bruin(7)
- Candy(151)
- Canon(247)
- Casio(40)
- Cenmax(17)
- Centurion(13)
- Clarion(49)
- Creative(10)
- Daewoo(86)
- DeLonghi(49)
- Denon(19)
- E-Ten(8)
- Electrolux(262)
- Elenberg(3)
- Epson(10)
- Ericsson(21)
- Explay(78)
- Fagor(104)
- Fly(36)
- FujiFilm(44)
- Garmin(31)
- Gefest(128)
- Gigabyte(16)
- Gorenje(26)
- Guard(13)
- Hansa(3)
- Hitachi(2)
- Hotpoint-Ariston(419)
- HP(21)
- HTC(42)
- Hyundai(408)
- Indesit(93)
- iRiver(31)
- Jaguar(6)
- Janome(20)
- Jassun(9)
- JJ-Connect(44)
- Juki(10)
- Jura(39)
- Just5(3)
- JVC(487)
- Kaiser(68)
- Kenwood(250)
- Kodak(38)
- KonicaMinolta(19)
- Lada(24)
- LG(714)
- Liebherr(28)
- Luxman(4)
- MegaJet(13)
- Microsoft(1)
- Miele(141)
- Minolta(29)
- Mio(11)
- Mitsubishi(6)
- Mongoose(49)
- Motorola(81)
- Moulinex(4)
- Mystery(412)
- Neff(118)
- Nexx(42)
- Nikon(80)
- Nintendo(1)
- Nokia(237)
- Novex(129)
- Olympus(126)
- Onkyo(22)
- Panasonic(1290)
- Pandora(14)
- Pantech(23)
- Pantera(20)
- Pentax(62)
- Pharaon(17)
- Philips(127)
- Pioneer(230)
- Premiera(6)
- Prology(195)
- Qtek(5)
- Rekam(15)
- Roland(28)
- Rolleiflex(4)
- Rolsen(72)
- RoverComputers(58)
- Sagem(18)
- Samsung(2617)
- Sanyo(15)
- Scarlett(320)
- Scher-Khan(13)
- Sendo(6)
- Sharp(392)
- Sheriff(21)
- Siemens(195)
- Smeg(17)
- Sony(563)
- SonyEricsson(118)
- SoundMax(102)
- Supra(35)
- Sven(114)
- Technics(71)
- Tefal(33)
- Texet(144)
- Thomas(25)
- Thomson(4)
- Tomahawk(16)
- Toshiba(210)
- Ubiquam(6)
- UFO(46)
- Vertu(11)
- Vestfrost(10)
- Viconte(92)
- Vitek(447)
- VK-Mobile(4)
- Voxtel(29)
- Whirlpool(67)
- Xoro(72)
- Yamaha(78)
- Yosan(5)
- Zanussi(293)
ManualsBrain
Бесплатная база инструкций и руководств для электронной техники и бытовых приборов
Watch the intro
Добро пожаловать на наш сайт Manualsbrain.com! Здесь вы найдете огромное количество инструкций к бытовым приборам ведущих мировых производителей от холодильника до магнитолы! Любой файл, который вы найдете в нашей библиотеке, вы можете скачать абсолютно бесплатно, потому что задачей нашего проекта в первую очередь является быстрая помощь людям, которые ищут руководства по эксплуатации к различной технике.
#оставайтесьдома
Оставайтесь дома. Здесь вы можете найти мануалы, связанные с медициной и здоровьем
Популярные инструкции
Популярные производители
- 3M
- ABB
- Amana
- American Range
- Apple
- Avanti
- Baumatic
- Beko
- Bertazzoni
- Bosch
- Candy
- Dacor
- Daewoo
- De Dietrich
- Fagor
- Frigidaire
- GE
- Gaggenau
- Grundig
- Haier
- Heartland
- Hitachi
- Honeywell
- Hoover
- Hotpoint
- IBM
- Intel
- Jenn-Air
- KitchenAid
- LG
- Lenovo
- Liebherr
- Marvel
- Maytag
- Miele
- Mitsubishi Electric
- NXR
- Nokia
- Premier
- Samsung
- Schneider Electric
- Siemens
- Sony
- Sterling
- Toshiba
- Verona
- Viking
- Whirlpool
- Wolf
- Zanussi
Новости Xiaomi
Подписаться на рассылку
Скачайте приложение Xiaomi Store
Самые актуальные предложения для лучших покупок