Инструкция юзер мануал инструкция на русском языке

• 
  Для кого. Для тех, кто делает первые шаги в использовании продукта
• 
  Цель и польза. Знакомство с основными функциями продукта, чтобы дальше использовать его самостоятельно
• 
  Форматы публикации. Текст и видеотуториалы

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

Источник: Segnetics

• 
  Для кого. Для всех пользователей
• 
  Цель и польза. В справочном руководстве описывают все возможности продукта и то, как им пользоваться
• 
  Форматы публикации. Текст и иллюстрации — например, скриншоты, дополнительно видео или gif

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

Хелп WEEEK

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

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

Источник: ELTEX

• 
  Для кого. Для администраторов компаний 
• 
  Цель и польза. Руководство помогает правильно управлять учётными записями других пользователей, выдавать им доступы к данным, помогать решать проблемы внутри продукта 
• 
  Форматы публикации. Текст

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

Источник: VK WorkSpace

• 
  Для кого. Для внутреннего использования с фокусом на потребностях разработчиков
• 
  Цель и польза. API-документация нужна для успешной интеграции API в проекты и полноценного использования его функций внутри системы
• 
  Форматы публикации. Текст

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

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

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

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

Наш хелп — справочное руководство пользователя. Мы пишем его вместе с разработчиками и продуктовой командой: они обладают практической информацией, без которой наш хелп был бы просто теорией. Советую перед определением содержания, подготовкой структуры и прочих нюансов изучить похожие продукты. Посмотри, что и как они подсвечивают в своих хелпах и выдели аналогичные топики, которые можно взять для себя. Например, мы в WEEEK изучали хелпы Notion, Trello и Asana

Наш хелп тут

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

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

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

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

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

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

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

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

Мы используем итеративную систему: написали статью, опубликовали её — статус у карточки на Канбане поменялся. При необходимости можно обратно вернуть её в работу. Каждая карточка привязывается к определённой статье. Ещё в карточках хранится вся информация о текстах — кто автор, ТЗ, прочие комментарии, когда дедлайн, какой приоритет и так далее 

Наш хелп

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

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

Наш хелп

Практические кейсы я получаю от директора по продукту WEEEK Инги Скерсь. Потому что об одной и той же вещи можно рассказать по-разному — это касается как изначального назначения, так и функций. Наш СЕО Иван Мараховка проводит свою аналитику, собирает вопросы от пользователей сервиса напрямую или от нашей AI-помощницы Вики, у которой пользователи спрашивают, как и что работает. Весь этот фидбек и информация добавляется в структуру хелпа и используется для написания новых статей 

Наш хелп

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

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

Наш хелп

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

ГлавнаяИнструкции, user manuals

Руководство по эксплуатации (РЭ) по ГОСТ 2.601-95

РЭ, как правило, состоит из введения и следующих частей:

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

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

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

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

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

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

Раздел «Описание и работа составных частей изделия» содержит общие сведения о составных частях изделия и состоит из подразделов:

Подраздел «Работа» содержит описание работы составных частей изделия

Содержание подразделов «Маркировка и пломбирование» и «Упаковка» составных частей изделия аналогично содержанию подразделов для изделия в целом

Часть «Использование по назначению» состоит из разделов:

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

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

Раздел «Подготовка изделия к использованию» содержит указания по проверке и приведению изделия к использованию по назначению.

Раздел, как правило, содержит подразделы:

Допускается эти особенности приводить в тексте РЭ, не выделяя в отдельный раздел

Часть «Техническое обслуживание» содержит сведения по техническому обслуживанию (ТО) изделия и его составных частей и состоит из разделов:

Перечень ГСМ, применяемых в изделии, рекомендуется излагать в виде таблицы 3.

Таблицу 3 заполняют на основании химитологической карты по ГОСТ 25549.

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

Графа «Периодичность способов смены (пополнения) ГСМ» заполняется в случае наличия в РЭ схемы заправки ГСМ. При необходимости допускается указывать дублирующие, резервные ГСМ, а также зарубежные ГСМ-аналоги [из п. 5.1.5.1.1 ГОСТ 2.601-95]

Подраздел «Меры безопасности» содержит правила, которые необходимо соблюдать в соответствии с особенностями конструкции изделия и его эксплуатации, действующими положениями нормативных документов, а также перечень обязательных требований по техническому обслуживанию и (или) ремонту, невыполнение которых может привести к опасным последствиям для жизни, здоровья человека или окружающей среды. Здесь же излагают правила пожарной безопасности, взрывобезопасности и т. п. [из п. 5.1.5.1.2 ГОСТ 2.601-95]

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

Содержание подраздела рекомендуется излагать в виде таблицы 4.

Таблица 4 — Порядок технического обслуживания

В графе «Пункт РЭ» указывают порядковый номер пункта (работы), под ним номер раздела, подраздела, пункта РЭ.

В графе «Наименование объекта ТО и работа» приводят наименование объекта ТО и перечень работ, проводимых при ТО.

В графе «Виды ТО» приводят условное обозначение вида ТО или периода выполнения видов ТО, а также условное обозначение выполняемой («+») или невыполняемой («-») работы. Графа может состоять из одной или нескольких колонок

Подраздел «Проверка работоспособности изделия» содержит последовательность выполнения работ по проверке работоспособности изделия.

Содержание подраздела рекомендуется излагать в виде таблицы 5.

Таблица 5 — Проверка работоспособности

В графе «Наименование работы» приводят наименование выполняемой работы в последовательности их выполнения.

В графе «Кто выполняет» указывают в сокращенном виде, кто выполняет работу, например М — механик, О — оператор и т. д.

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

В графе «Контрольные значения параметров» указывают значения, в пределах которых должны находиться параметры, контролируемые при проверке исправности изделия, и значения параметров, при которых изделие отправляют в ремонт. При изложении сведений о контролируемых (измеряемых) параметрах необходимо указывать: наименование параметра; номинальное значение; допуск (доверительный интервал); применяемое средство измерения.

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

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

Подраздел «Консервация (расконсервация, переконсервация)» содержит сведения о средствах и методах наружной и внутренней консервации, расконсервации, переконсервации (далее — консервации) изделия в целом, периодичности консервации при хранении, порядок приведения изделия в состояние готовности к использованию по назначению из состояния консервации, перечень используемых инструментов, приспособлений и материалов [из п. 5.1.5.1.6 ГОСТ 2.601-95]

Раздел «Техническое обслуживание составных частей изделия», как правило, содержит подразделы:

Подраздел «Обслуживание» содержит правила и порядок замены и заправки изделия ГСМ с указанием их количества и марки по соответствующему нормативному документу, а также условия и порядок заправки дублирующими (резервными) ГСМ и, при необходимости, зарубежными ГСМ

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

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

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

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

Подраздел «Консервация» содержит требования, аналогичные изложенным в 5.1.5.1.6

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

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

Подраздел «Меры безопасности» содержит правила предосторожности, которые в соответствии с действующими нормативами должны быть соблюдены при проведении работ

Раздел «Текущий ремонт составных частей изделия» содержит указания по поиску и устранению последствий отказов и повреждений и применительно к каждой составной части изделия, текущий ремонт которых возможен при эксплуатации, состоит из подразделов:

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

Подраздел «Устранение последствий отказов и повреждений» содержит указания о методах устранения последствий отказов и повреждений, а также перечень необходимых для этого средств измерения, инструмента и приспособлений. Подраздел рекомендуется оформлять в виде карты (см. приложение А).

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

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

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

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

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

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

Часть «Хранение» содержит:

Часть «Транспортирование» содержит:

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

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

Часть «Утилизация» содержит: