📚 Руководства (пользователя, администратора)

Как писать руководства: виды, структура, стиль, шаблоны инструкций и чек-лист качества.

Шпаргалки · Документы · #documents #documentation #user-guide

Виды руководств

Документ Для кого О чём
Руководство пользователя конечные пользователи как решать задачи в системе
Руководство администратора админы, поддержка установка, настройка, роли, резервные копии
Руководство оператора операторы рабочие процедуры, ввод данных
Руководство программиста / API разработчики интерфейсы, примеры, ограничения
Руководство по эксплуатации эксплуатация мониторинг, обслуживание, инциденты
Краткое руководство (Quick Start) новичок первые шаги за 5 минут
FAQ, база знаний все ответы на частые вопросы

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

  1. Назначение системы и аудитория.
  2. Требования к рабочему месту (браузер, ОС).
  3. Вход и роли.
  4. Описание интерфейса (скриншоты с подписями).
  5. Пошаговые инструкции по задачам.
  6. Типовые ошибки и их решение.
  7. Контакты поддержки.
  8. Глоссарий.

Структура руководства администратора

  1. Архитектура и компоненты (схема).
  2. Требования к окружению.
  3. Установка и первичная настройка.
  4. Параметры конфигурации.
  5. Управление пользователями и правами.
  6. Резервное копирование и восстановление.
  7. Обновление и откат.
  8. Мониторинг и журналы.
  9. Диагностика и типовые инциденты.
  10. Безопасность.

Шаблон инструкции

Название задачи: «Создать заказ» Когда использовать: когда клиент оформляет покупку по телефону. Перед началом: нужна роль «Менеджер». Шаги:

  1. Откройте раздел Заказы → Создать.
  2. Выберите клиента из списка.
  3. Добавьте товары кнопкой +.
  4. Нажмите Сохранить.

Результат: заказ в статусе «Новый», номер показан вверху. Если не получилось: см. раздел «Ошибки».

Стиль

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

Чек-лист качества

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