ТЕХНИЧЕСКИЙ ПИСАТЕЛЬ:

Ольга Кириченко, ведущий технический писательUNIGINE, Томск

ОЖИДАНИЕ VS РЕАЛЬНОСТЬ

ЦЕЛИ

1. Познакомить с профессией технического писателя

2. Поделиться опытом разработки документации в IT компании

3. Рассказать про жанры документации, в которых мы пишем

4. Сравнить собственные ожидания от профессии и действительность

О КОМПАНИИ

UNIGINE. ПРОДУКТЫ• 3D платформа UNIGINE

исходный код платформы визуальный редактор SDK-браузер консольные инструменты документация

• Продукты на базе движка бенчмарки симуляторы игры

• Web-ресурсы промо-сайт портал для разработчиков

КТО ТАКОЙ ТЕХНИЧЕСКИЙ ПИСАТЕЛЬ?

ПЕРЕВОДЧИК vs ТЕХНИЧЕСКИЙ ПИСАТЕЛЬ

ТЕХНИЧЕСКИЙ ПИСАТЕЛЬ ОТЧАСТИ:

• Писатель

• Журналист

• Разработчик

• Тестировщик

• Иллюстратор

ОБЪЕМЫ РАБОТЫ

• 13 программистов• Более 12 лет R&D• Более 1 000 000 строк кода на С++• 5-6 релизов SDK в год• Объем изменений в неделю:

~10 новых методов API, ~2-3 фичи в движке и редакторе

• 1400 статей в одной версии (700 000 слов)• 3000 иллюстраций• Отдельная версия документации

для каждого релиза• 3 языка (En, Ru, Ch)• Более 5000 методов API x3 языка

(С++, C#, UnigineScript)• 3 тех. писателя

ПРОДУКТ ДОКУМЕНТАЦИЯ

ПРОЦЕСС НАПИСАНИЯ СТАТЬИ

• Определение ЦА• Опрос программистов, чтение кода• Отсеивание ненужного• Тестирование• Разработка (опционально)• Написание документации• Вычитка

РАСПРЕДЕЛЕНИЕ ВРЕМЕНИ

АУДИТОРИЯ

• Программисты (графики, логики, инструментария) и технические художники• 3D-художники

• Потенциальные покупатели Менеджеры Программисты 3D-художники

• Все у кого есть интерес к технологии

ВНУТРЕННЯЯ ВНЕШНЯЯ

ЖАНРЫ ДОКУМЕНТАЦИИ

1. МЕНТАЛЬНАЯ МОДЕЛЬ

• Базовые сущности и их взаимосвязи• Принципы работы подсистем• Связи со смежными областями

! Повествование в стиле Википедии

2. РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ (GUI)

• Описание интерфейса инструментов• Требуемое рабочее окружение• Краевые значения параметров• Влияние одних параметров на другие

! Текст, изображения (+GIF)

3. СПРАВОЧНИК API

• Описание классов, функций и аргументов• Ограничения и краевые случаи• Примеры использования кода

! Быстрый поиск

4. ТУТОРИАЛ

• Пошаговое руководство с «нуля» до результата• Объясняем, как сделать, а не почему

так устроено

! Много картинок, видео

СТАНДАРТЫ, ИНСТРУМЕНТЫ, КАЧЕСТВО

СТАНДАРТЫ

• Пишем в свободном стиле, не по ГОСТу• Пишем себе сами стандарты• Используем Microsoft Manual of Style• Обучались онлайн в Sprott business school

ИНСТРУМЕНТЫ

• Автогенерация API• Система контроля версий• Тесты, валидация• Входные: XML, CMS• Выходные: HTML

КАЧЕСТВО

• Отзывы клиентов• Частота появления запросов на форуме• Тест на новичках в компании• Product-менеджеры

ДЕМОГРАФИЯ

Высшее образование

Пол

Дополнительное образование

Возраст

ОЖИДАНИЯ vs РЕАЛЬНОСТЬ

Будет время досконально изучить продукт

Первая задача «Применение процедурных генераторов в создании контента для real-time 3D приложений»

Программисты будут подробно рассказывать про сделанную работу, и как этим пользоваться

Сделал, но молчит как партизан

Буду работать над одной статьей, доведу ее до совершенства

Работаю над десятью параллельно, уже не помню о чем была первая

Напишу один раз хорошо и всем будет счастье

Полностью переписываю одну и ту же статью раз в два месяца

ВЫВОДЫ

НЕОБХОДИМЫЕ ЛИЧНЫЕ КАЧЕСТВА• Нужно быстро осваивать

большие объемы информации• Любовь к людям• Многозадачность• Оптимизм

• Причастность к крутой технологии и общество умных коллег• Широкий IT кругозор• Навык описания сложных вещей

простыми словами• Регулярная практика английского

в различных жанрах• Возможность развиваться в

любом направлении параллельно

ПЛЮСЫ

СПАСИБО!

Ольга Кириченкоqubblr@unigine.com

unigine.com