Чек-лист для технического писателя
Работа над техническим текстом закончена, если выполнены следующие условия:
- Определена целевая аудитория текста и ее потребности.
- Текст помогает решать задачи пользователя.
- Включена необходимая информация: описаны все функции и подпрограммы, константы и переменные, модули и библиотеки.
- Соблюдены правила единой терминологии.
- Соблюдены стандарты документирования.
- Текст логически выстроен и структурирован.
- Текст понятен даже начинающему пользователю.
- Текст легко читается.
- Текст живой и интересный.
- Короткие предложения из 10-15 слов.
- Отсутствуют сложные словесные конструкции, стилистические ошибки.
- Отсутствуют орфографические и пунктуационные ошибки.
- Отсутствуют опечатки.
- Текст разбит на абзацы из 2-3 предложений.
- Короткие заголовки и подзаголовки.
- Используются списки.
- Информация визуализирована: используются изображения, скриншоты, схемы, таблицы, инфографика.
- Отсутствует двусмысленность.
- Использованы примеры использования той или иной функции.
- Инструкции тщательно проверены и работают так, как описано.
- Используются ссылки.
- Грамотная верстка и типографика.
Нужно больше информации? Научиться писать профессиональные технические тексты поможет новый курс повышения квалификации в ЦНТИ Прогресс:
КУРС “Технический писатель. Разработка технических текстов”
4 - 8 июля | Санкт-Петербург
- 10 мастер-классов от руководителей и старших специалистов петербургских ИТ-компаний, преподавателей кафедры информационного менеджмента СПбГИК.
- Современные технологии разработки различных видов технических текстов: технической документации, руководства пользователя, онлайн-справки, научно-технической рекламы и др.
- Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по российским и зарубежным стандартам.
- Методы создания понятных текстов. Сторителлинг.
- Визуализация данных. Инфографика. Интеллект-карты.
- Перевод технической документации.
- Программное обеспечение для технического писателя.
- Разработка документации на основе принципа единого источника (DITA, Oxygen).
Для участников:
- обучение по программе с выдачей Удостоверения о повышении квалификации в объеме 40 часов (лицензия № 0327 от 25.01.2013),
- сборник информационно-справочных материалов;
- экскурсионная программа;
- ежедневные обеды и кофе-паузы,
- обмен опытом с коллегами из различных отраслей и регионов России,
- новые профессиональные знакомства.