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

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

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

КУРС “Технический писатель. Разработка технических текстов”

4 - 8 июля | Санкт-Петербург

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

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

Цветочный бизнес: как стать успешным в кризис?

Цветочный магазин – это не только красивый, но еще и высокодоходный бизнес. Однако растущий курс валют, санкции и падение покупательского спроса наложили на него свой негативный отпечаток. Продажи упали в два-три раза: изменилась структура спроса на цветущий товар. Но не стоит отчаиваться. Давайте учиться жить в новых реалиях — быстро реагировать на изменение ситуации и принимать правильные решения. Как это сделать, расскажут петербургские эксперты на семинаре ЦНТИ Прогресс:
Управление цветочным бизнесом в новой экономической реальности 12 – 15 июля

В программе широкий круг вопросов, связанных с эффективным управлением цветочным магазином:
Прогноз продаж цветов и дальнейшего развития цветочного бизнеса Эффективные технологии управления персоналом
Особенности работы с отечественными производителями цветов, новые тенденции Все нюансы переговоров с поставщиками. Как научиться убеждать, как избежать конфликтов?
Покупательское поведение, изменения в динамике потребления цветов Правовые аспекты бизнеса
Методы повышения прибыльности торговой точки Эффективные технологии продвижения с минимальным бюджетом. Электронные каналы продаж

А также самые последние тенденции отрасли – создание и развитие корпоративных сетей. Технологии укрупнения: экономический расчет. Слияния и поглощения: примеры, способы противостояния, анализ ошибок.
Ведущий преподаватель — Воробьев Павел Федорович
Идейный вдохновитель — Бермяков Владимир Александрович
Учредитель ООО "ЦветоДом". Производство и продажа цветов с 2004 года: собственные теплицы, сеть из 48 торговых точек. Бизнес - консультант. Опыт работы 15 лет. В цветочном бизнесе консультирует сетевые предприятия по продаже цветов, букетов, сопутствующих товаров; классическую цветочную сеть опт-розница, цветочные бутики, сети доставки цветов, подарков, поздравлений, а также другие предприятия из разных сфер бизнеса. Ведущий тренингов для топ-менеджмента организаций в области управления изменениями. Преподаватель Высшей экономической школы Санкт-Петербургского Государственного экономического университета, преподаватель Высшей Школы Экономики (НИУ ВШЭ). Автор более 50-ти публикаций в области финансов, экономики, управления, маркетинга, развития организаций. Один из самых известных российских флористов, многократный призер международных конкурсов и выставок, чемпион страны по флористике, обладатель трех серебряных медалей Экспо 90 –Япония. Вы посетите флористическую «Студию А. и В. Бермяковых», где у вас будет уникальная возможность пообщаться с необыкновенно талантливым человеком в неформальной, творческой обстановке. Клиентами студии не раз становились главы государств, сэр Элтон Джон, Джейн Фонда, Клаудиа Шиффер. Цветочные композиции студии украшали Эрмитаж, Мраморный дворец. Русский музей, Юсуповский и Большой Петергофский дворцы, Екатерининский дворец в Царском селе, Атриум Петропавловской крепости, Исаакиевский собор, Михайловский и Мариинский театры.

Посещение магазина цветов ОРАНЖ
Для эффективной работы в любом виде деятельности крайне необходим обмен опытом с коллегами в своей сфере. В рамках семинара запланированы экскурсии в цветочные магазины и салоны Санкт-Петербурга. Вы сможете ознакомиться с работой одной из ведущих цветочных компаний города - ОРАНЖ.
Смотрите подробную программу семинара и записывайтесь