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

Объявляется набор
студентов старших курсов
ММФ, ФИТ, ФФ, ФИЯ, ФЕН, ЭФ
на факультативный спецкурс
«Технический писатель в ИТ компании»

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

Успешно закончившие спецкурс награждаются именными сертификатами, дающими преимущественное право поступления на работу в компанию Parallels*

Программа курса доступна на сайте swsoft.nsu.ru.

Преподаватель – Руководитель группы технических писателей проект SDK Documentation Компании Parallels И.Фильковская.

Начальные требования к слушателям:

  • Знание английского на уровне Advanced, Upper-Intermediate, Intermediate.
  • Умение свободно излагать мысли.

Предварительная запись на спецкурс (указать ф.и.о. полностью, факультет, курс, номер группы, e-mail, телефон для связи) проводится по e-mail: [neva@ccfit.nsu.ru]

Первая встреча и тестирование будет проходить 18 февраля 2008 с 16.00-19.30 корпус юридического факультета НГУ, ул. Ильича 21, ауд. 8

*Parallels (ранее SWsoft) - это мировой лидер в области программ виртуализации и автоматизации, которые помогают оптимизировать использование вычислительных ресурсов компьютеров, серверной инфраструктуры в интересах частных лиц, компаний и провайдеров услуг на всех основных аппаратных и операционных системах, а также платформах виртуализации. С момента своего основания в 1999 году Parallels остается быстро развивающейся компанией, чей штат насчитывает более 900 сотрудников на всей территории Северной Америки, Европы и Азии. Информация в Интернет: www.parallels.com. http://www.parallels.com


Рабочая программа
  1. Вводное занятие
    1. Объем понятия «Техническая документация». Техническая документация, ориентированная на пользователей и разработчиков. Обзор целевой аудитории и основных типов документов.
    2. Жизненный цикл программного продукта, место и роль в нем технического писателя. Взаимодействие писателя с другими командами. Типы и структура ИТ компаний.
  2. Стили написания технической документации. Писательство для международной аудитории
    1. Основные требования к техническим документам. Обзор стилей написания технической документаций и особенностей письменного технического языка.
    2. Инструкции по написанию документации, понятной для представителей других культур. Особенности создания документов, подлежащих локализации. Особенности создания документов, не подлежащих переводу на другие языки. Simplified English, Globish.
  3. Этапы писательского процесса. Часть I. Начальные этапы подготовки
    1. Обзор пяти неотъемлемых этапов писательского процесса. Вариации в организации процесса (линейное написание, итеративное).
    2. Планирование и исследование (изучение продукта, анализ аудитории, поиск информации).
  4. Этапы писательского процесса. Часть II. Дальнейшие этапы
    1. Организация документа - составление структуры документа, составление заголовков, графическая организация содержимого: функции и правила составления списков, таблиц, примечаний, ссылок и других элементов текста. Написание. Редакция.
    2. Этапы писательского процесса при итеративном написании документа, первый, второй, третий черновики.
  5. Важные приемы, используемые писателем
    1. При создании пользовательской документации: использование правильной лексики для описании графического интерфейса (GUI); работа с иллюстрациями; использование цитат, ссылок на другие работы.
    2. При создании документации для разработчиков: выбор стратегии изложения и оформления информации; «погружение» документа в специфическую среду, использование графики, написание сценариев.
  6. Task-oriented документация.
    1. Понятие task-oriented документации. Особенности направленности на задачи в документации для пользователей и разработчиков.
    2. Методы подачи task-oriented информации в пользовательских документах. Написание задач, процедур и шагов.
    3. Task-oriented документация для разработчиков: принципы организации документа.
  7. ПО для создания документации
    Использование специализированного программного обеспечения для написания документации. Краткий обзор такого ПО. Знакомство с AuthorIT.
  8. Работаем с AuthorIT. Занятие первое
    Знакомство с основными объектами и сущностями: библиотеки, книги, стили, ссылки, скриншоты, таблицы. Начинаем создавать свой документ.
  9. Работаем с AuthorIT. Занятие второе
    Топики, подробнее о стилях, индекс, глоссарий.
  10. Работаем с AuthorIT. Занятие третье
    Завершающие стадии работы. Оптимизация документа. Публикация в различные форматы (MS Word, HTML).
  11. Итоговое занятие
    Краткое рассмотрение незатронутых тем, ответы на вопросы, подготовка к тесту.