2. Общая информация. Это один или несколько разделов (глав, параграфов и т.д.), содержащих сведения о системных и аппаратных требованиях программы, её ключевые характеристики, расширенную информацию о её назначении, данные об авторских правах. Зачастую сюда же выносятся сведения, связанные с её лицензионным использованием. Для оборудования отличий здесь также нет, кроме возможных требований к условиям эксплуатации (температурный режим, например).
3. Используемые обозначения и сокращения. Раздел, где вы перечисляете и расшифровываете все используемые в тексте сокращения (кроме общепринятых, вроде «и т.д.»), аббревиатуры и значки (например, восклицательный знак «Внимание!». Иногда его может не быть, вместо этого все сокращения расшифровываются при первом упоминании в тексте.
4. Установка. Алгоритм действий по установке ПО на компьютер или установке в помещение и подключению к сети электронного оборудования.
5. Настройка. Описывается комплекс подготовительных мер, предназначенных для ввода в эксплуатацию программы или устройства. Для многих бытовых изделий и приложений для домашних ПК этот пункт может отсутствовать, поскольку нет обязательных к изменению настроек.
6. Использование в работе. Часть, непосредственно посвящённая описанию приложения или устройства и работе с ним пользователя. Основной и самый крупный раздел документа.
7. Удаление. Для ПО в этом разделе описывается стандартная процедура удаления, для оборудования — демонтаж и условия утилизации, если они отличаются от типовых (вынести на помойку).
8. Возможные проблемы и частые вопросы. Это не обязательный, но очень желательный в любой инструкции раздел. Особенно он требуется различным новинкам, которые представлены на рынке первыми версиями и за которыми пока нет многих человеколет отладки и устранения ошибок в различных нештатных ситуациях. В разделе перечисляются наиболее часто встречающиеся ошибки и неполадки с указанием, как поступать пользователю при их возникновении.
2. Формат и структура статьи. Канон и отступления от него
Существует несколько типов статей, с которыми технический писатель может столкнуться в своей работе. В зависимости от типа статьи будет меняться стиль изложения, её структура и целевая аудитория. Ниже перечислены основные типы статей:
Аналитическая статья-сравнение. В этой статье несколько сущностей (это могут быть продукты, компании, политические партии, словом — всё, что угодно) сравниваются друг с другом по нескольким заранее определённым параметрам. Такая статья всегда имеет практическую ценность, т. к. облегчает читателю выбор между представленными сущностями (самый нейтральный пример: сравнение кухонных комбайнов разных марок по цене, функционалу, удобству использования и дизайну).
