Требования к инструкциям

Инструкция по установке и настройке

• Вступление: назначение приложения.
• Технические требования.
• Особенности установки приложения (список настроек, которые необходимо выполнить в дополнение к стандартному процессу установки).
• Описание шагов настройки приложения для начала работы.
• Описание шагов настройки по сопровождению работы в приложении (например, настройка дополнительных возможностей, описание процессов и процедур, которые без участия пользователей выполняют обработку данных, и др.).

Инструкция пользователя

• Вступление: назначение приложения, особенности использования.
• Описание работы пользователя (все разработанные функциональные возможности).
• Примеры пользовательских use-кейсов.
• Примечания и ограничения.

Требования к файлу

• Формат: PDF.
• Файл включает титульную страницу, содержание и основной материал.
• Титульная страница содержит название приложения и название (или логотип) компании.
• Содержание сформировано стандартными средствами MS Word с возможностью автоматического обновления.
• Заголовок файла: “Инструкция по установке и настройке приложения %Название приложения%” и “Инструкция пользователя %Название приложения%”.
• Шаблон для оформления файла можно скачать по ссылке.

Стилистика

• Текст логично структурирован, используются заголовки, подзаголовки, маркированные и нумерованные списки, выделение полужирным (bold).
• При описании последовательности действий используются глаголы в повелительном наклонении (“откройте”, “перейдите”, “запустите” и т. п.).
• В инструкции содержится достаточная информация, для того чтобы пользователь смог самостоятельно пройти описанный кейс, не должно быть пропущенных шагов. Функциональность описана максимально точно, с использованием правильных названий всех объектов, элементов пользовательского интерфейса и компонентов программного обеспечения.
• Для элементов интерфейса используется терминология, принятая в документации Creatio. Для одного и того же понятия во всей инструкции используется один и тот же термин. Примеры терминов:
  • Раздел;
  • Реестр, список;
  • Страница, страница записи;
  • Деталь;
  • Вкладка;
  • Поле;
  • Группа полей;
  • Область действий;
  • Дизайнер системы;
  • Коммуникационная панель.
• В тексте используется длинное тире (сочетание клавиш Alt+0151) “—”. Между цифрами используется короткое соединительное тире без пробелов (сочетание клавиш Alt+0150): “10–15”.
• В тексте не используется буква “ё”.
• В сокращениях “и т. д”, “и т. п.”, “т. е.” используется пробел.
• Названия клавиш клавиатуры, например, стрелок, функциональных клавиш, клавиш смены регистра, приводятся заглавными буквами (исключениями являются описательные названия клавиш, например, Windows). Например: “Нажмите клавиши ALT+F3”.
• Названия элементов интерфейса приводятся в квадратных скобках. Например: “Нажмите кнопку [Добавить]”, “Заполните поле [Название]”.
• Во всем тексте используется одинаковый тип кавычек: “”.

Оформление текста

• Во всем документе используется шрифт Verdana, цвет серый (RGB 89, 89, 89).
• Кегль основного текста (включая списки, таблицы): 10 px.
• Кегль подзаголовков: 14 px.
• Кегль заголовков: 16 px.
• Кегль заголовков рисунков: 9 px.
• Межстрочный интервал основного текста: 1,15.
• Межстрочный интервал заголовков (в том числе для заголовков рисунков, таблиц): 1,5.
• Все поля страницы: 2,5.
• В тексте не используются принудительные переносы.
• Абзацы обычного текста без отступа.
• Отступ списков первого уровня: 0,63. Отступ списков второго уровня: 1,9.
• Текст не содержит пустых вводов.
• Рисунки и таблицы имеют сквозную нумерацию.
• Выравнивание основного текста — по ширине.
• Выравнивание заголовков и подзаголовков — по левому краю.
• Для формата маркированных и нумерованных списков первого уровня используется голубой цвет (RGB 100, 184, 223).

Оформление рисунков

• Скриншоты сняты любой программой для съемки экрана — Snagit, Monosnap, ScreenSh3ooter и т. п.
• Формат рисунков PNG или JPEG.
• Допускается выделение ключевых элементов интерфейса (поля, детали, области). Для выделения используется прямоугольная рамка красного цвета толщиной 2 px. Максимальное количество рамок на одном рисунке — 2. Другие способы выделения на рисунке (стрелки, текст и т. п.) не используются.
• Все рисунки подписаны и пронумерованы.
• Заголовок и номер рисунка размещается непосредственно перед рисунком. Шрифт: Verdana, кегль 8, цвет светло-серый (RGB 150, 150, 150). Выравнивание по левому краю. Межстрочный интервал заголовка рисунка: 1,5.
• Все рисунки должны упоминаться в тексте.
• Положение рисунков: “В тексте”.
• Выравнивание рисунков: по центру.