Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Технический писатель в IT: ожидание/реальность ...

Технический писатель в IT: ожидание/реальность (Ольга Кириченко)

http://docfactor.ru.

4 ноября 2016, Новосибирск

Технический писатель в IT: ожидание/реальность (Ольга Кириченко, UNIGINE, Томск)

Видеозапись: https://www.youtube.com/watch?v=fFQOvwTE_vM

«Суровые сибирские техписатели читают и пишут код на С++!», и другие реальные истории из жизни штатного сотрудника томской компании UNIGINE, разрабатывающей собственную платформу 3D-графики.

В своем докладе я расскажу про:

- Роль отдела технической документации для продукта;
- Процессы и инструменты разработки документации в нашей компании;
- Оценку качества разработанной документации;
- Плюсы и минусы профессии;
- Пути развития и карьерный рост специалистов;
- Личные качества и знания, необходимые для достижения успеха в нашей отрасли.

DocFactor — конференция о технической документации и ее роли в разработке ПО.

Подробнее: http://docfactor.ru

More Decks by DocFactor: конференция о технической документации

Other Decks in Education

Transcript

  1. ЦЕЛИ 1. Познакомить с профессией технического писателя 2. Поделиться опытом

    разработки документации в IT компании 3. Рассказать про жанры документации, в которых мы пишем 4. Сравнить собственные ожидания от профессии и действительность
  2. UNIGINE. ПРОДУКТЫ • 3D платформа UNIGINE  исходный код платформы

     визуальный редактор  SDK-браузер  консольные инструменты  документация • Продукты на базе движка  бенчмарки  симуляторы  игры • Web-ресурсы  промо-сайт  портал для разработчиков
  3. • 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 тех. писателя ПРОДУКТ ДОКУМЕНТАЦИЯ
  4. • Определение ЦА • Опрос программистов, чтение кода • Отсеивание

    ненужного • Тестирование • Разработка (опционально) • Написание документации • Вычитка
  5. • Программисты (графики, логики, инструментария) и технические художники • 3D-художники

    • Потенциальные покупатели  Менеджеры  Программисты  3D-художники • Все у кого есть интерес к технологии ВНУТРЕННЯЯ ВНЕШНЯЯ
  6. 1. МЕНТАЛЬНАЯ МОДЕЛЬ • Базовые сущности и их взаимосвязи •

    Принципы работы подсистем • Связи со смежными областями ! Повествование в стиле Википедии
  7. 2. РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ (GUI) • Описание интерфейса инструментов • Требуемое

    рабочее окружение • Краевые значения параметров • Влияние одних параметров на другие ! Текст, изображения (+GIF)
  8. 3. СПРАВОЧНИК API • Описание классов, функций и аргументов •

    Ограничения и краевые случаи • Примеры использования кода ! Быстрый поиск
  9. 4. ТУТОРИАЛ • Пошаговое руководство с «нуля» до результата •

    Объясняем, как сделать, а не почему так устроено ! Много картинок, видео
  10. СТАНДАРТЫ • Пишем в свободном стиле, не по ГОСТу •

    Пишем себе сами стандарты • Используем Microsoft Manual of Style • Обучались онлайн в Sprott business school
  11. КАЧЕСТВО • Отзывы клиентов • Частота появления запросов на форуме

    • Тест на новичках в компании • Product-менеджеры
  12. Буду работать над одной статьей, доведу ее до совершенства Работаю

    над десятью параллельно, уже не помню о чем была первая
  13. НЕОБХОДИМЫЕ ЛИЧНЫЕ КАЧЕСТВА • Нужно быстро осваивать большие объемы информации

    • Любовь к людям • Многозадачность • Оптимизм • Причастность к крутой технологии и общество умных коллег • Широкий IT кругозор • Навык описания сложных вещей простыми словами • Регулярная практика английского в различных жанрах • Возможность развиваться в любом направлении параллельно ПЛЮСЫ