22 правила хорошего технического текста

Чек-лист для технического писателя

Работа над техническим текстом закончена, если выполнены следующие условия:

  1. Определена целевая аудитория текста и ее потребности.
  2. Текст помогает решать задачи пользователя.
  3. Включена необходимая информация: описаны все функции и подпрограммы, константы и переменные, модули и библиотеки.
  4. Соблюдены правила единой терминологии.
  5. Соблюдены стандарты документирования.
  6. Текст логически выстроен и структурирован.
  7. Текст понятен даже начинающему пользователю.
  8. Текст легко читается.
  9. Текст живой и интересный.
  10. Короткие предложения из 10-15 слов.
  11. Отсутствуют сложные словесные конструкции, стилистические ошибки.
  1. Отсутствуют орфографические и пунктуационные ошибки.
  2. Отсутствуют опечатки.
  3. Текст разбит на абзацы из 2-3 предложений.
  4. Короткие заголовки и подзаголовки.
  5. Используются списки.
  6. Информация визуализирована: используются изображения, скриншоты, схемы, таблицы, инфографика.
  7. Отсутствует двусмысленность.
  8. Использованы примеры использования той или иной функции.
  9. Инструкции тщательно проверены и работают так, как описано.
  10. Используются ссылки.
  11. Грамотная верстка и типографика.

Нужно больше информации? Научиться писать профессиональные технические тексты поможет новый курс повышения квалификации в ЦНТИ Прогресс:

  • 10 мастер-классов от руководителей и старших специалистов петербургских ИТ-компаний, преподавателей кафедры информационного менеджмента СПбГИК.
  • Современные технологии разработки различных видов технических текстов: технической документации, руководства пользователя, онлайн-справки, научно-технической рекламы и др.
  • Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по российским и зарубежным стандартам.
  • Методы создания понятных текстов. Сторителлинг.
  • Визуализация данных. Инфографика. Интеллект-карты.
  • Перевод технической документации.
  • Программное обеспечение для технического писателя.
  • Разработка документации на основе принципа единого источника (DITA, Oxygen).

Стоимость пятидневного курса: 35 500 рублей.

Для участников:

  • обучение по программе с выдачей Удостоверения о повышении квалификации в объеме 40 часов (лицензия № 0327 от 25.01.2013),
  • сборник информационно-справочных материалов;
  • экскурсионная программа;
  • ежедневные обеды и кофе-паузы,
  • обмен опытом с коллегами из различных отраслей и регионов России,
  • новые профессиональные знакомства.

ПОДРОБНАЯ ПРОГРАММА И РЕГИСТРАЦИЯ