Факультативный спецкурс

"Технический Писатель в ИТ компании"

Преподаватели:
Елена Дерябина, руководитель подразделения технической документации, SWsoft, Inc.
Андрей Симиненко, руководитель рабочей группы отдела технической документации, проект PEM, SWsoft, Inc.

Требования к слушателям:

Спецкурс ориентирован на студентов III-IV курсов технических специальностей и владеющих английским языком.

Программа занятий

  1. Вводное занятие
    Описание функций и навыков технического писателя. Обзор целевой аудитории и основных типов документов. Взаимодействие писателя с другими командами.

 

  1. Этапы писательского процесса. Часть I. Начальные этапы подготовки
    Обзор пяти неотъемлемых этапов писательского процесса. Планирование и исследование (изучение продукта, анализ аудитории, поиск информации).

 

  1. Этапы писательского процесса. Часть II. Дальнейшие этапы
    Организация (составление структуры документа), написание, редакция.   
  2. Стили написания технической документации
    Обзор стилей написания технической документаций и особенностей письменного технического языка.

 

  1. Писательство для международной аудитории
    Советы по написанию документации, понятной для представителей других культур. 

 

  1. Анализ структуры текста
    Составление заголовков, списков, таблиц, примечаний, ссылок и других элементов текста.

 

  1. Написание задач, процедур и шагов
    Описание способов правильной подачи task-oriented информации.  

 

  1. Важные приемы, используемые писателем
    Использование правильной терминологии и глаголов для описании графического интерфейса (GUI). Работа с иллюстрациями. Использование цитат, ссылок на другие работы.

 

  1. ПО для создания документации
    Использование специализированного программного обеспечения для написания документации. Краткий обзор такого ПО. Знакомство с AuthorIT.

 

  1. Работаем с AuthorIT. Занятие первое
    Знакомство с основными объектами и сущностями: библиотеки, книги, стили, ссылки, скриншоты, таблицы. Начинаем создавать свой документ.

 

  1. Работаем с AuthorIT. Занятие второе
    Топики, подробнее о стилях, индекс, глоссарий.

 

  1. Работаем с AuthorIT. Занятие третье
    Завершающие стадии работы. Оптимизация документа. Публикация в различные форматы (MS Word, HTML).

 

  1. Итоговое занятие
    Краткое рассмотрение незатронутых тем, ответы на вопросы, подготовка к тесту.