Использовать этот шаблон
Отличное руководство пользователя для ПО короче, точнее и больше ориентировано на задачи, чем полноценный мануал — и часто оказывается полезнее. С Trupeer вы можете сэкономить часы на написании руководств, начав с бесплатного шаблона руководства пользователя, настроив его с помощью ваших бренд-гайдлайнов и используя наш AI-создатель мануалов, чтобы превратить продуктовые обходы в увлекательные видеоинструкции.
Что такое бесплатный шаблон руководства пользователя для ПО?
Бесплатный шаблон руководства пользователя для ПО — это повторно используемая структура документации, которую читают конечные пользователи: как делать то, для чего предназначено ПО, написанное для человека, который им пользуется, а не для того, кто его собирает или обслуживает.
Это один элемент большой семьи. Справочная документация, записи по архитектуре, эксплуатационные runbook’и и релиз-ноты обслуживают разных читателей, а страница шаблонов ПО объясняет, как именно они разделяются. Эта страница — про тот вариант, который открывают ваши клиенты.
Шаблон — это не руководство. Список разделов занимает двадцать минут на написание. То, что определяет, будет ли руководство работать, — это структурное допущение, которое большинство шаблонов перенимают, даже не замечая, и оно неверное.
Формат следует за использованием. Word-файл шаблона руководства пользователя для ПО подходит для руководства, которое доставляется как документ — сейчас это меньшинство, но всё ещё распространено для on premise-решений и регулируемых продуктов. А Word-файл шаблона пользовательского руководства — это та же традиция, только под более старым названием. Шаблон пошагового руководства в Word с разметкой «свободного» формата — ближайшая общая точка старта. Разметка PPT-шаблона руководства пользователя для ПО подходит для обучающих материалов, полученных из руководства, а не для самого руководства, а Excel-файл шаблона руководства пользователя для ПО — для инвентаризации контента, а не для руководства. Сейчас большинство руководств пользователя для ПО живут на сайте справки, и это заметно меняет структуру — по причине ниже.
Никто не читает руководство пользователя с начала
Посмотрите аналитику любого онлайн-сайта справки — и один показатель окончательно расставит точки над i.
Доля визитов, которые начинаются со стартовой страницы или страницы содержания, невелика. Большинство пользователей приходят сразу на «глубокую» страницу — из веб-поиска или по ссылке на справку внутри продукта — с одним конкретным вопросом.
Они не читали введение. Они не знают, в какой главе находятся. Они не видели раздел с терминологией, инструкции по настройке и примечание во второй главе, где объясняется, что всё последующее предполагает уже настроенную учетную запись.
И всё же почти каждое руководство пользователя структурировано как книга: страница содержания, главы в логическом порядке и страницы, которые предполагают, что читатель уже прошёл предыдущие. Эта структура унаследована от печатных мануалов, где она была уместна, и сохраняется в онлайн-справке, где уже нет.
В итоге получается документ, который логичен для его автора и «сломанный» для реального читателя. Страница, начинающаяся с фразы «продолжение предыдущего раздела», — тупик для семидесяти процентов людей, которые не пришли из предыдущего раздела.
Как настроить этот шаблон в Trupeer
Шаг 1: Откройте раздел «Шаблоны»
Перейдите в раздел «Шаблоны» из главной навигации.
Шаг 2: Выберите и откройте шаблон
Нажмите на любой шаблон, с которым хотите работать, чтобы открыть его.
Шаг 3: Разверните просмотр шаблона
При необходимости разверните просмотр шаблона, чтобы увидеть полную разметку и детали.
Шаг 4: Отредактируйте шаблон
Нажмите «Редактировать», чтобы начать изменять выбранный шаблон.
В редакторе вы можете:
Добавлять новые разделы
Определять или обновлять правила форматирования
Добавить логотип и настроить его положение и связанные параметры
Шаг 5: Сохраните настроенный шаблон
После того как вы внесёте все необходимые изменения, нажмите «Сохранить», чтобы сохранить обновлённый шаблон как свой.
Шаг 6: Предпросмотр и точная настройка шаблона
Когда вы захотите увидеть, как выглядит ваш настроенный шаблон, откройте «Предпросмотр».
На экране предпросмотра при необходимости вы можете продолжить вносить изменения напрямую, чтобы шаблон отображался ровно так, как вам нужно.
С шаблоном руководства пользователя для ПО вы можете:
Экономить время на написании: пропускайте пустую страницу с структурой, созданной для руководств пользователя.
Сокращать количество обращений в поддержку: понятные инструкции помогают пользователям решать вопросы самостоятельно.
Оставаться в фирменном стиле: применяйте логотип, шрифты и цвета с помощью бренд-набора Trupeer.
Ускорять внедрение: ориентированные на задачи инструкции помогают пользователям получать ценность быстрее.
Добавлять видеообходы: встраивайте видео для шагов, которые сложно объяснить текстом.
Достигать глобальной аудитории: переводите руководства пользователя на 65+ языков одним кликом.
Каждая страница — это страница первая
Правило дизайна следует напрямую. Пишите каждую страницу так, будто это единственная страница, которую читатель когда-либо увидит, потому что для большинства так и есть.
Шесть последствий — и все они недорогие.
Указывайте на странице, что предполагает страница. Не во вступлении. Если задача требует роли администратора, настроенной интеграции или выполненного шага настройки — скажите об этом в первых двух строках, где человек сможет понять, что он не на том месте, прежде чем потратит пять минут на выяснение.
Повторяйте, а не делайте перекрёстные ссылки. Три строки повторяющихся предварительных условий дешевле, чем ссылка, по которой читатель должен перейти, прочитать и вернуться. Повторение обижает авторов и помогает читателям, а вы пишете именно для читателя.
Убирайте все ссылки на расположение. Как описано выше, в предыдущем разделе, используя метод из 5.2. Каждый из этих пунктов предполагает порядок чтения, который большинство читателей не соблюдает. Заменяйте либо на реальную инструкцию, либо на именованную ссылку.
Озаглавливайте страницу как вопрос, а не как функцию. Ниже будет раскрыто подробнее, потому что это разница между тем, чтобы вас находили, и тем, чтобы вас не находили.
Заканчивайте одним-двумя выбранными следующими шагами. Не деревом навигации. Читатель уже закончил что-то, и обычно есть один очевидный следующий шаг — назовите его.
Объединяйте любые страницы, которые не могут существовать отдельно. Если страница действительно не имеет смысла без другой, это одна страница, которую разделили для удобства автора.
Поэтому лучший бесплатный шаблон руководства пользователя для ПО — тот, который позволяет писать именно так. Проверка занимает секунды. Откройте любую страницу в своём руководстве «с холодного старта», как будто вы пришли из поиска, и спросите себя, сможете ли вы выполнить задачу. Большинство руководств проваливают это на большинстве своих страниц, а провалы сосредоточены в середине глав, где у авторов было больше контекста в голове.
Что должна содержать страница руководства пользователя для ПО
Компоненты для одной страницы — поскольку единицей является страница, а не книга.
Компонент | Что он делает |
|---|---|
Заголовок как вопрос пользователя | Что они бы ввели или спросили, а не как функция называется внутри |
Для чего эта страница | Одна строка. Чего вы достигнете в конце. |
Что она предполагает | Роль, права, предварительная настройка, предыдущее состояние. Указывается, а не даётся ссылкой. |
Нумерованные шаги | По одному действию на каждый шаг, в порядке выполнения. |
Что вы должны увидеть | На каждый шаг, где результат неочевиден, чтобы читатель понимал, продолжать или нет. |
Скриншот или короткое видео, где распознавание важнее описания | Только там, где это оправдано — по причинам, описанным ниже. |
Частые проблемы | Две или три, взятые из обращений в поддержку, а не придуманные. |
Следующие шаги | Один или два, выбранные осознанно. |
Дата последней проверки и версия | Когда в последний раз кто-то выполнял эти шаги и для какой версии продукта. |
В целом по набору вам также нужен поиск, который работает, способ для читателей сообщать, что страница неверна, и владелец. Ссылка для отчёта — самый дешёвый механизм качества, и почти у никого её нет.
Бесплатный шаблон руководства пользователя для ПО: структура, которую нужно копировать
Заполнено реальным примером, а не плейсхолдерами. ПО — это система управления ветеринарной практикой.
Скопируйте отсюда.
Заголовок. Как вернуть деньги клиенту. Не: обработка отмены кредит-ноты.
Для чего эта страница. Вернуть деньги клиенту за инвойс, который он уже оплатил, и корректно отразить это в учётных записях практики.
Что она предполагает. У вас есть право Billing (Биллинг). В практиках на тарифе Standard оно включено по умолчанию только для менеджеров практики. Инвойс оплачен и сверен. Если он не оплачен, вы ищете отмену инвойса — это другая страница, и ссылка на неё есть в конце.
Шаги.
Откройте карточку клиента и выберите вкладку Billing. Вы должны увидеть список инвойсов с указанием статуса напротив каждого.
Найдите оплаченный инвойс. Оплаченные инвойсы отмечены зелёной галочкой. Если вместо этого отображается янтарные часы, значит сверка ещё не выполнена, и вам нужно дождаться сверки, прежде чем оформлять возврат.
Выберите инвойс, затем Refund (Возврат). Откроется панель возврата, где показана полная сумма.
Введите сумму возврата. Частичные возвраты разрешены. Сумма не может превышать оплаченную общую сумму.
Выберите причину из списка. Она появится в выписке клиента, поэтому выберите ту, которую вы готовы, чтобы они прочитали.
Выберите Process refund (Оформить возврат). Вы должны увидеть подтверждение со ссылкой на возврат, начинающейся с REF.
Что вы должны увидеть после этого. Статус инвойса изменится на Refunded или Partially refunded. Возврат появится в day book в течение пятнадцати минут.
Частые проблемы.
Кнопка Refund (Возврат) неактивна (серого цвета) — обычно это означает, что инвойс ещё не сверен. Подождите и обновите страницу.
Возврат не отображается в day book — обычно это значит, что возврат был обработан после закрытия day book и появится завтра.
Вы вообще не видите вкладку Billing — значит, у вас нет права Billing. Ваш менеджер практики может выдать его.
Следующие шаги. Только два. Отмена неоплаченного инвойса. Формирование выписки клиента.
Последняя проверка. 7 мая, версия 14.2, выполнено сотрудником команды поддержки, который следовал этим шагам с самого начала.
Скопируйте сюда.
Обратите внимание: раздел «Что предполагается» дублирует информацию, которая также находится на странице с правами. Это дублирование намеренное — и в этом смысл.
Пример руководства пользователя: сто двенадцать страниц, которым нужна была ещё одна страница
Marlbury Systems поставляет ПО для управления практикой примерно четырём с половиной тысячам ветеринарных практик. Их руководство пользователя насчитывало сто восемьдесят страниц, было опубликовано онлайн и структурировано как мануал: начало работы, клиенты и пациенты, приёмы, клинические разделы, биллинг, отчёты, администрирование.
Оно было тщательным, точным и хорошо написанным. Его подготовил технический писатель, который хорошо понимал продукт.
Два числа из аналитики запустили расследование. Семьдесят восемь процентов визитов приходили прямо на «глубокую» страницу — из поисковой системы или по ссылке на справку внутри продукта. А среднее время на странице составляло четырнадцать секунд.
Четырнадцать секунд — это не чтение. Это переход, беглый просмотр и уход.
Команда поддержки дала вторую половину картины. Пять самых посещаемых страниц справки создавали больше обращений, чем любые другие — то есть ровно наоборот тому, для чего нужна справка.
Кто-то проверил руководство на соответствие одному вопросу: сможет ли читатель, пришедший на эту страницу «с холодного старта», выполнить задачу.
Сто двенадцать из ста восьмидесяти страниц содержали хотя бы одну ссылку на другой материал, без которого задача не решалась. Как описано выше. Продолжение предыдущего раздела. Использование метода из 5.2. После того как вы завершили настройку в первой главе.
Страница про возврат, одна из самых посещаемых во всём руководстве, начиналась с предложения, которое отсылало читателя к предыдущему разделу, чтобы найти инвойс. Большинство людей, которые читали её, никогда не видели предыдущий раздел и не имели причин знать, что он существует.
Переписывание не изменило факты. Предварительные условия переформулировали на каждой странице, а не ссылались на них. Ссылки на расположение заменили реальными инструкциями. Заголовки страниц переписали по данным собственного поискового лога сайта: он показывал, что пользователи ищут возврат, хотя страница называлась «обработка отмены кредит-ноты». На каждой странице появился короткий блок «что предполагается» и два выбранных следующих шага.
Через четыре месяца время на странице выросло с четырнадцати секунд до семидесяти одной. Обращения, ссылающиеся на топ-20 тем, снизились примерно на сорок один процент. Доля пользователей, которые открывали справку внутри продукта и затем не обращались в поддержку, выросла с тридцати четырёх процентов до пятидесяти восьми.
Руководство стало длиннее, потому что повторяющиеся предварительные условия занимают место. Но им стали пользоваться.
Как написать руководство пользователя для ПО за шесть шагов
Получите список страниц из данных поддержки и поиска, а не из структуры меню продукта. Обращения подскажут, что люди не могут сделать, а поисковый лог — какие слова они используют.
Пишите по одной странице на каждую задачу, с заголовком в виде вопроса.
Сначала напишите блок с допущениями, а уже потом шаги. Это раздел, который не даёт человеку потратить пять минут на неправильную страницу.
Пишите шаги, выполняя их, а не по памяти. Всё, что вы делаете автоматически, иначе будет упущено.
Возьмите частые проблемы из очереди обращений. Три реальных случая лучше, чем десять придуманных.
Проверьте «с холодного старта». Откройте страницу так, как открыл бы её незнакомый человек, и попробуйте выполнить задачу, не открывая ничего другого.
Шаг первый — это то, что отделяет руководство, организованное вокруг пользователей, от руководства, организованного вокруг ПО. Структура меню продукта — это карта того, как было построено ПО. Это не карта того, что люди пытаются сделать.
Как называть страницы, чтобы люди их находили
Заголовки важнее в руководстве пользователя, чем почти в любом другом документе, потому что поиск — основной вход, и заголовок несёт большую часть «веса» совпадений.
Три правила.
Используйте слово пользователя, а не своё. Если поисковый лог показывает, что люди вводят «возврат», а на вашей странице написано «отмена кредит-ноты», то страница для них невидима. Проверьте лог. Это самый дешёвый способ исследования, и большинство команд никогда его не открывают.
Начинайте с глагола. Как вернуть деньги клиенту. Не: возвраты клиентам, обзор. Сначала глагол лучше соответствует тому, как люди формулируют запросы, и быстрее читается в списке результатов.
Одна задача — один заголовок. Страница с заголовком «управление биллингом» охватывает всё и не соответствует ничему. Разделите её.
Если внутренний термин действительно правильный, потому что он появляется в интерфейсе, поставьте слово пользователя в первой строке страницы, чтобы её всё ещё можно было найти. Вы оптимизируете сразу для двух аудиторий: поисковую систему и человека, который просматривает результаты.
Скриншоты и проблема сопровождения
Скриншоты помогают больше всего там, где распознавание важнее описания: когда нужно определить один элемент управления среди многих, показать незнакомый экран и подтвердить, как выглядит успешный результат.
Но они также являются самым крупным риском по сопровождению в руководстве пользователя. Руководство с двумя сотнями скриншотов — это руководство с двумя сотнями вещей, которые тихо ломаются при следующем изменении интерфейса, а интерфейсы меняются каждые несколько недель.
Три правила помогают держать затраты пропорциональными.
Используйте их там, где сложно назвать, и пропускайте там, где инструкция понятна сама по себе. Скриншот кнопки с подписью «Сохранить» не добавляет ничего.
Добавляйте пометки напрямую, а не описывайте в тексте, куда смотреть. Немаркированный скриншот загруженного экрана — это головоломка.
Указывайте дату и знайте, какую версию продукта они показывают, чтобы читатель мог понять, существует ли то, что он видит, всё ещё.
Честная позиция в том, что большинство команд начинают с хороших намерений по визуальной документации и заканчивают текстом, потому что стоимость повторного захвата после каждого релиза превышает доступное время. Это производственная проблема, а не проблема желания — и она рассматривается дальше.
Руководство пользователя, пользовательский мануал или how-to?
Три пересекающихся термина, и различия полезны при выборе структуры.
Руководство пользователя охватывает продукт ПО по задачам, которые выполняют его пользователи. Несколько страниц, открываемых в любой момент, поддерживаются непрерывно.
Пользовательский мануал — это то же самое в более старой, «документной» традиции, и термин всё ещё стандартен для физических продуктов и для ПО, поставляемого on premise. Когда мануал сопровождает физическое оборудование, требования по безопасности и размещению предупреждений отличаются от того, что есть в руководствах по ПО, и традиция инструкционного мануала закрывает эту область.
How-to (пошаговая инструкция) — это одна задача, самостоятельная, по сути одна страница из руководства пользователя, опубликованная отдельно.
Практический вывод: если вы пишете каждую страницу так, чтобы она стояла отдельно, как обсуждалось выше, то ваше руководство пользователя уже является набором how-to с навигацией поверх — это правильная архитектура для онлайн-справки.
Краткое справочное руководство — это ещё один вариант: лист для поиска информации для человека, который уже обучен, и он описан на странице краткого справочного руководства.
Что бесплатный шаблон руководства пользователя для ПО не может исправить
Руководство, структурированное вокруг продукта. Ни один шаблон не превращает руководство, организованное вокруг функций, в руководство, организованное вокруг задач. Для этого нужны данные поддержки и поиска.
Страницы, которые никто не может найти. Хорошо написанная страница с неправильным заголовком невидима. Заголовки — самое дешёвое, что можно исправить, и к ним обращаются реже всего.
Скриншоты, которые никто не сопровождает. Ни бесплатная загрузка шаблона руководства пользователя для ПО, ни бесплатная загрузка шаблона пользовательского мануала не «вернут» двести изображений после редизайна.
Продукт, которому требуется так много подсказок. Если задаче действительно нужны четырнадцать шагов и три предупреждения, значит документация делает работу, которую должен делать интерфейс. Напишите это всё равно и передайте наблюдение тому, кто отвечает за продукт.
Показывайте задачу, а не описывайте её
Руководство пользователя — это тип документа с самым высоким требованием к изображениям и самой высокой стоимостью их сопровождения, и именно эти два факта вместе объясняют, почему так много руководств хуже, чем задумывали их авторы.
Математика здесь безжалостна. Руководство на сто страниц с тремя изображениями на страницу — это триста захватов, обрезок, аннотаций и размещений. После редизайна всё снова становится триста. Никто не располагает таким временем в неделю релиза, поэтому изображения устаревают, а устаревшие изображения хуже, чем отсутствие, потому что читатели им доверяют.
Trupeer AI меняет базу затрат. Один человек выполняет задачу один раз во время записи, а результат — это написанная пошаговая страница со скриншотами, которые уже захвачены, аннотированы и размещены, плюс короткое видео — в вашем собственном фирменном стиле. То, что раньше занимало полдня, теперь занимает минуты, а повторный захват после редизайна означает повторную запись, а не пересъёмку.
Запишите. Оформите в бренде. Переведите. Trupeer’ьте.
Есть ещё два момента, которые особенно важны для руководств пользователя. Видео находится на странице рядом с письменными шагами — это обслуживает и читателя, который хочет быстро просканировать, и читателя, который хочет смотреть, и это действительно разные люди, а не один и тот же человек в разное время. А если ваши пользователи говорят на нескольких языках, то одна и та же запись создаёт одинаковую страницу на каждом языке, поэтому руководство, переведённое один раз, не «отстаёт» от продукта, пока английская версия сохраняет темп.
Материалы размещаются в вашем knowledge base и одновременно служат обучением для сотрудников поддержки, которые часто являются самыми активными пользователями руководства. Согласованность между документами — это вопрос один раз настроить бренд-набор, а настройка описана в руководстве по настройке шаблона документа.
Часто задаваемые вопросы
Есть ли бесплатный шаблон руководства пользователя для ПО в формате Word?
Word подходит для руководства, которое доставляется как документ — это актуально для on premise ПО, регулируемых продуктов, где требуется мануал с версиями, и для любых материалов, передаваемых по договору. Word-файл шаблона руководства пользователя для ПО хорошо работает для таких случаев.
Но для ПО со справочным сайтом это работает плохо. Пользователи приходят через поиск, им нужно, чтобы каждая страница имела свой адрес, а Word-документ создаёт один длинный файл без точки входа на каждую страницу. Если вы публикуете онлайн, используйте систему документации и оставляйте Word только для версии, которая передаётся как отдельный комплект.
Есть ли бесплатная версия шаблона пошагового руководства пользователя в Word?
Да, и структура выше вставляется напрямую. Соберите разметку бесплатного шаблона пошагового руководства пользователя в Word: одна задача на каждый раздел, нумерованные шаги — по одному действию на шаг, и строка с допущениями вверху каждого раздела.
Делайте разделы достаточно короткими, чтобы они могли существовать отдельно. Самая частая ошибка в Word-ориентированных руководствах — раздел, который имеет смысл только после предыдущего. В документе это незаметно, но критично, когда тот же контент публикуется онлайн.
Есть ли бесплатная версия шаблона руководства пользователя для ПО в формате PPT?
Слайды подходят для обучения, которое получается из руководства, а не для самого руководства. Бесплатный набор PPT-шаблона руководства пользователя для ПО — разумный формат для сессии walkthrough или онбординг-вебинара.
Не используйте его как справочник. Слайды не ищутся так, как нужно пользователям, их нельзя связать изнутри продукта, а чтение набора в одиночку лишает его повествования, которое несёт большую часть смысла.
Есть ли бесплатная версия шаблона руководства пользователя для ПО в формате Excel?
Excel — не формат руководства, но он действительно полезен рядом с ним. Бесплатный Excel-файл шаблона руководства пользователя для ПО хорошо подходит как инвентаризация контента: одна строка на страницу, с её заголовком, владельцем, датой последней проверки, версией продукта, ежемесячными просмотрами и объёмом связанных обращений.
Именно этот инвентарь подсказывает, какие страницы нужно исправлять в первую очередь. Страницы с высоким трафиком и большим объёмом связанных обращений — это те, которые не работают, и без инвентаря вы будете исправлять ту страницу, о которой кто-то пожаловался совсем недавно.
Есть ли смысл использовать бесплатную загрузку шаблона руководства пользователя для ПО?
Структура страницы занимает двадцать минут на сборку, поэтому бесплатная загрузка шаблона руководства пользователя для ПО экономит немного, а большинство опубликованных шаблонов оформлены как книги: со страницей содержания и пронумерованными главами.
Принятие такой формы — это ошибка, против которой выступает эта страница. Если вы используете её, уберите нумерацию глав и сделайте каждую страницу самостоятельной — это изменение способа написания, а не файла.
Является ли Word-файл шаблона пользовательского мануала тем же самым?
В целом — да, но различие скорее в традиции, чем в содержании. Word-файл шаблона пользовательского мануала происходит от линии печатного мануала, поэтому он предполагает последовательное чтение, страницу содержания и номера страниц.
Это работает для документа, который действительно будут читать как документ, включая регулируемые материалы и мануалы, сопровождающие физическое оборудование. Для онлайн-справки источником проблемы, описанной на этой странице, являются допущения, заложенные в такой подход.
Где можно получить бесплатную загрузку шаблона пользовательского мануала?
Он широко доступен и в основном взаимозаменяем, потому что пронумерованный список задач — несложная разметка. Бесплатная загрузка шаблона пользовательского мануала даст вам страницу содержания, заголовки глав и структуру страниц.
Два изменения, которые стоит внести в любой из них: блок с допущениями вверху каждого раздела и удаление всех перекрёстных ссылок на расположение. Эти два правки занимают час на существующем руководстве и стоят больше, чем смена шаблона.
Какой лучший бесплатный шаблон руководства пользователя для ПО?
Лучший бесплатный шаблон руководства пользователя для ПО — тот, который рассматривает страницу, а не книгу, как единицу, и почти никто так не делает.
Если вы сравниваете варианты, проверьте одну вещь: есть ли у шаблона место на каждой странице, чтобы фиксировать, что читатель уже сделал до этого? Именно это поле позволяет странице «выживать», когда на неё приходят из поиска — так доберётся до неё большинство ваших читателей.
