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

Что такое шаблон руководства и какой вам нужен?

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

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

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

Руководство с двумя подписантами — это не одно руководство

Вот проверка — и она занимает около минуты.

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

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

Механизм прост — и он полностью сводит на нет добрые намерения. Контент, принадлежащий разным людям, меняется с разной скоростью. Заявления по безопасности меняются редко и требуют соответствия. Инструкции по эксплуатации меняются с каждым релизом и требуют продукта. Устранение неполадок меняется еженедельно и требует сервисную команду. Объедините их в один документ — и самое дешевое изменение унаследует самый медленный путь согласования, поэтому исправление на девять страниц будет ждать обзор на двести страниц.

Все участники действуют разумно на каждом шаге — и руководство все равно устаревает. Именно поэтому этот тип провала так распространен: никто ничего не делает неправильно.

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

Как настроить этот шаблон в Trupeer

Шаг 1: Откройте раздел «Шаблоны»

Перейдите в раздел «Шаблоны» из главного меню.

Шаг 2: Выберите и откройте шаблон

Нажмите на любой шаблон, с которым хотите работать, чтобы открыть его.

Шаг 3: Разверните просмотр шаблона

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

Шаг 4: Отредактируйте шаблон

Нажмите «Изменить», чтобы начать редактирование выбранного шаблона.

В редакторе вы можете:

• Добавлять новые разделы

• Определять или обновлять правила форматирования

• Добавить логотип и настроить его положение и связанные параметры

Шаг 5: Сохраните настроенный шаблон

После того как вы внесете все необходимые изменения, нажмите «Сохранить», чтобы сохранить обновленный шаблон как свой.

Шаг 6: Предпросмотр и точная настройка шаблона

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

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

С шаблонами руководств Trupeer вы можете:

• Экономить часы на написании: пропускайте пустую страницу — используйте проверенные структуры для любого типа руководств.

• Охватить все сценарии использования: шаблоны для руководств пользователя, обучения, эксплуатации, инструкций и политики.

• Оставаться в фирменном стиле: применяйте логотип, шрифты и цвета с помощью бренд-набора Trupeer.

• Снизить нагрузку на поддержку: понятные руководства помогают пользователям решать вопросы самостоятельно — сокращаются обращения и переделки.

• Добавлять видеоуроки: встраивайте видео для шагов, которые сложно объяснить текстом.

• Достигать глобальных пользователей: переводите руководства на 65+ языков в один клик.

Типы руководств, кто их подписывает, и как часто они меняются

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

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

Бесплатный шаблон руководства: структура, которую разделяет каждое руководство

Какой бы тип руководства вы ни писали, вводная часть одинакова — и это та часть, которую большинство черновиков пропускают. Скопируйте отсюда.

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

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

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

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

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

Как использовать это руководство. Две-три строки: читается целиком или используется точечно, где находится оглавление, что делать, если в нем нет вашего случая.

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

Что делать, если это не помогает. Названный маршрут, а не общий адрес поддержки.

Скопируйте сюда. Строка с версией и два имени — это поля, которые отделяют руководство от документа, и это первое, что вырезают, когда кто-то торопится.

Как разделить руководство, которое уже написано

Большинство людей попадает на эту страницу с уже существующим документом, а не с пустой страницей, поэтому это важнее, чем шаблон.

Распечатайте его или откройте страницу с содержанием. Для каждого раздела запишите одно имя: кто должен одобрить изменение этого. Не кто его написал.

Сгруппируйте разделы по этому имени. Эти группы — ваши руководства. На практике обычно вы найдете три или четыре группы и один «сиротский» раздел, который никто не будет брать в работу, и этот «сиротский» раздел обычно уже неактуален.

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

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

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

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

Kilnmore Systems производит коммерческое прачечное оборудование для отелей и больниц. Каждая машина поставляется с эксплуатационным и сервисным руководством на сто сорок восемь страниц.

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

В 2024 году релиз прошивки изменил меню эксплуатации. Около девяти страниц руководства стали неверными.

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

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

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

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

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

Как написать руководство, которое люди действительно откроют

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

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

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

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

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

Проверьте это, наблюдая, как один человек использует руководство без вашей помощи. Любая пауза — это дефект. Это занимает сорок минут и находит больше трех раундов обзора.

Что должно быть включено в шаблон руководства?

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

Все остальное — типоспецифично. Руководству пользователя для ПО нужны скриншоты и структура, удобная для поиска. Эксплуатационному руководству нужны предупреждения, встроенные в текст, график обслуживания и информация о соответствии требованиям. Учебному руководству нужны цели и способ проверить, что читатель понял материал — и это не нужно остальным вообще.

То, что люди чаще всего оставляют за кадром и чего не стоит делать, — это имя согласующего, по той причине, что вся страница посвящена именно этому.

Шаблоны руководств пользователя для ПО и веб-приложений

У руководств по ПО есть одно свойство, которого нет у остальных: продукт меняется под документом непрерывно, поэтому все, что вы пишете, «стареет» с того дня, как его выпустили.

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

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

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

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

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

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

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

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

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

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

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

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

Могу ли я получить шаблон руководства в Word, Canva или Google Docs?

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

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

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

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

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

Разделение документа решает проблему согласования. Оно не решает проблему написания: обновление руководства означает, что кто-то делает скриншоты, обрезает и переписывает шаги, которые он уже знает, и эта работа никогда не выигрывает у чего-то срочного.

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

Запишите это. Оформите в бренде. Переведите. Сделайте Trupeer.

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

Часто задаваемые вопросы

Есть ли пошаговый шаблон руководства пользователя в Word — бесплатно?

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

Есть ли бесплатный шаблон учебного руководства в Word?

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

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

Canva хорошо подходит для коротких визуальных руководств: листов быстрых стартов, инструкций по эксплуатации на одной странице, всего, что будет закреплено на стене. Возьмите поля вводной части с этой страницы и разложите их там. Для всего, что достаточно длинное, чтобы понадобились оглавление или перекрестные ссылки, используйте Word или Google Docs.

Есть ли шаблон руководства пользователя для Google Docs?

Скопируйте структуру выше в Google Doc и сохраните его в папку вашей команды как шаблон. Он подходит для совместного черновика и чтения онлайн, а комментарии при обзоре — это реальное преимущество. Следите за длиной: Docs становится медленным и громоздким на очень длинных руководствах.

В чем разница между руководством, гайдом и SOP?

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

Какой должна быть длина руководства?

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

Кто должен писать руководство?

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

Как часто нужно пересматривать руководство?

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