Технический писатель: ожидание vs реальность (Ольга...
-
Upload
unigine-corp -
Category
Software
-
view
60 -
download
6
Transcript of Технический писатель: ожидание vs реальность (Ольга...
![Page 1: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/1.jpg)
ТЕХНИЧЕСКИЙ ПИСАТЕЛЬ:
Ольга Кириченко, ведущий технический писательUNIGINE, Томск
ОЖИДАНИЕ VS РЕАЛЬНОСТЬ
![Page 2: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/2.jpg)
ЦЕЛИ
1. Познакомить с профессией технического писателя
2. Поделиться опытом разработки документации в IT компании
3. Рассказать про жанры документации, в которых мы пишем
4. Сравнить собственные ожидания от профессии и действительность
![Page 3: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/3.jpg)
О КОМПАНИИ
![Page 4: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/4.jpg)
UNIGINE. ПРОДУКТЫ• 3D платформа UNIGINE
исходный код платформы визуальный редактор SDK-браузер консольные инструменты документация
• Продукты на базе движка бенчмарки симуляторы игры
• Web-ресурсы промо-сайт портал для разработчиков
![Page 5: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/5.jpg)
![Page 6: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/6.jpg)
![Page 7: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/7.jpg)
![Page 8: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/8.jpg)
![Page 9: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/9.jpg)
![Page 10: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/10.jpg)
![Page 11: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/11.jpg)
![Page 12: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/12.jpg)
КТО ТАКОЙ ТЕХНИЧЕСКИЙ ПИСАТЕЛЬ?
![Page 13: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/13.jpg)
ПЕРЕВОДЧИК vs ТЕХНИЧЕСКИЙ ПИСАТЕЛЬ
![Page 14: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/14.jpg)
ТЕХНИЧЕСКИЙ ПИСАТЕЛЬ ОТЧАСТИ:
• Писатель
• Журналист
• Разработчик
• Тестировщик
• Иллюстратор
![Page 15: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/15.jpg)
ОБЪЕМЫ РАБОТЫ
![Page 16: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/16.jpg)
• 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 тех. писателя
ПРОДУКТ ДОКУМЕНТАЦИЯ
![Page 17: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/17.jpg)
ПРОЦЕСС НАПИСАНИЯ СТАТЬИ
![Page 18: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/18.jpg)
• Определение ЦА• Опрос программистов, чтение кода• Отсеивание ненужного• Тестирование• Разработка (опционально)• Написание документации• Вычитка
![Page 19: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/19.jpg)
РАСПРЕДЕЛЕНИЕ ВРЕМЕНИ
![Page 20: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/20.jpg)
АУДИТОРИЯ
![Page 21: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/21.jpg)
• Программисты (графики, логики, инструментария) и технические художники• 3D-художники
• Потенциальные покупатели Менеджеры Программисты 3D-художники
• Все у кого есть интерес к технологии
ВНУТРЕННЯЯ ВНЕШНЯЯ
![Page 22: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/22.jpg)
ЖАНРЫ ДОКУМЕНТАЦИИ
![Page 23: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/23.jpg)
1. МЕНТАЛЬНАЯ МОДЕЛЬ
• Базовые сущности и их взаимосвязи• Принципы работы подсистем• Связи со смежными областями
! Повествование в стиле Википедии
![Page 24: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/24.jpg)
2. РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ (GUI)
• Описание интерфейса инструментов• Требуемое рабочее окружение• Краевые значения параметров• Влияние одних параметров на другие
! Текст, изображения (+GIF)
![Page 25: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/25.jpg)
3. СПРАВОЧНИК API
• Описание классов, функций и аргументов• Ограничения и краевые случаи• Примеры использования кода
! Быстрый поиск
![Page 26: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/26.jpg)
4. ТУТОРИАЛ
• Пошаговое руководство с «нуля» до результата• Объясняем, как сделать, а не почему
так устроено
! Много картинок, видео
![Page 27: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/27.jpg)
СТАНДАРТЫ, ИНСТРУМЕНТЫ, КАЧЕСТВО
![Page 28: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/28.jpg)
СТАНДАРТЫ
• Пишем в свободном стиле, не по ГОСТу• Пишем себе сами стандарты• Используем Microsoft Manual of Style• Обучались онлайн в Sprott business school
![Page 29: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/29.jpg)
![Page 30: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/30.jpg)
ИНСТРУМЕНТЫ
• Автогенерация API• Система контроля версий• Тесты, валидация• Входные: XML, CMS• Выходные: HTML
![Page 31: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/31.jpg)
КАЧЕСТВО
• Отзывы клиентов• Частота появления запросов на форуме• Тест на новичках в компании• Product-менеджеры
![Page 32: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/32.jpg)
ДЕМОГРАФИЯ
![Page 33: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/33.jpg)
Высшее образование
Пол
Дополнительное образование
Возраст
![Page 34: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/34.jpg)
ОЖИДАНИЯ vs РЕАЛЬНОСТЬ
![Page 35: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/35.jpg)
Будет время досконально изучить продукт
Первая задача «Применение процедурных генераторов в создании контента для real-time 3D приложений»
![Page 36: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/36.jpg)
Программисты будут подробно рассказывать про сделанную работу, и как этим пользоваться
Сделал, но молчит как партизан
![Page 37: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/37.jpg)
![Page 38: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/38.jpg)
![Page 39: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/39.jpg)
Буду работать над одной статьей, доведу ее до совершенства
Работаю над десятью параллельно, уже не помню о чем была первая
![Page 40: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/40.jpg)
Напишу один раз хорошо и всем будет счастье
Полностью переписываю одну и ту же статью раз в два месяца
![Page 41: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/41.jpg)
![Page 42: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/42.jpg)
ВЫВОДЫ
![Page 43: Технический писатель: ожидание vs реальность (Ольга Кириченко) - DocFactor 2016](https://reader031.fdocument.pub/reader031/viewer/2022012406/58d0a0011a28abdd648b6607/html5/thumbnails/43.jpg)
НЕОБХОДИМЫЕ ЛИЧНЫЕ КАЧЕСТВА• Нужно быстро осваивать
большие объемы информации• Любовь к людям• Многозадачность• Оптимизм
• Причастность к крутой технологии и общество умных коллег• Широкий IT кругозор• Навык описания сложных вещей
простыми словами• Регулярная практика английского
в различных жанрах• Возможность развиваться в
любом направлении параллельно
ПЛЮСЫ