Техническая документация и стоит ли ее бояться: 
в НГУ прошла вторая конференция DocFactor’17

http://nsu.ru/docfactor_nsu

Что такое техническая документация? Кто такие технические писатели? Это и многое другое можно было узнать 26 ноября на DocFactor’17 — конференции для технических писателей, проходившей на Факультете информационных технологий НГУ.

Несмотря на то что слово «технический» может показаться несколько скучным, на DocFactor’17 оно звучало настолько часто, что им невольно можно было проникнуться. Докладчики поделились своим опытом о том, как настраивать процессы документирования в производстве, что нужно для оценки трудозатрат и времени документирования, что такое руководства по стилю документации, и о том, какую роль играет видео в документации. Также участники узнали о современных инструментах разработки документации и о том, как документация помогает бизнесу получать прибыль и принимать важные решения. В завершении конференции состоялся круглый стол, на котором обсуждались сроки и затраты на документирование, и мастер-класс, где участники с нуля написали и опубликовали небольшие веб-сайты.

Участники конференции
  • Павел Семенов, ведущий инженер компании «Сбербанк-Технологии», рассказал о видеоинструкциях и обучающих видео для пользователей.
  • Константин Медведев, руководитель сектора поддержки продуктов компании «Тион», рассказал о пользе своевременного документирования и о подходах к документированию «из памяти».
  • Алексей Лебедев, руководитель проектов компании «Философт», рассказал о том, как оценить затраты времени и ресурсов на разработку документации.
  • Николай Волынкин, технический писатель компании Plesk, рассказал о том, как использовать в разработке документации инструменты и методы разработки ПО, и провёл мастер-класс, участники которого за полтора часа настроили систему для разработки и публикации документации.
  • Семён Факторович, консультант documentat.io, преподаватель НГУ и главный организатор конференции DocFactor, рассказал о руководствах по стилю написания документации.
  • Максим Строев, директор по разработкам компании HDsoft, рассказал о том, как документация помогает бизнесу получать прибыль и принимать важные решения.
  • Виктория Кондрашук, технический писатель компании «Финансовые Информационные Системы», рассказала об улучшении продукта путем улучшения документации, о влиянии технического писателя на производительность труда и о системном подходе к процессам документирования.
  • Леонид Станкевич, руководитель аналитического отдела компании UNISCAN RESEARCH, рассказал об особенностях разработки документации для военных.

Как нам подсказывает Википедия:

Техническая документация — это «набор документов, используемых при проектировании (конструировании), создании (изготовлении) и использовании (эксплуатации) каких-либо технических объектов». Такими объектами могут быть, например, программное обеспечение, какие-то модные современные устройства (вроде того же смартфона), даже здания. Все это требует четкого отслеживания всех процессов, которые происходят в ходе разработки продукта.

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

— В основном наш отдел документирования разрабатывает два типа технической документации, — говорит Константин Медведев, руководитель сектора поддержки продуктов компании «Тион» — то, что помогает пользователю в эксплуатации продукта, и то, что помогает сервисной службе поддерживать пользователей. За своевременным появлением и полнотой остальной документации на продукты (электронные узлы, конструкция, испытания и т.д.) мы просто внимательно следим.

В российских университетах нет специальности «технический писатель», хотя есть отдельные курсы — например, в магистратуре ФИТ НГУ. Разные компании требуют от технических писателей разных компетенций и ставят перед ними разные задачи. Обычно нужны как гуманитарные компетенции: грамотная речь и любовь к тексту, так и технические: понимание предметной области компании. Поэтому техническими писателями становятся как технари, так и гуманитарии.

—Компания «Тион» разрабатывает и производит продукты — приборы, которые устанавливаются в квартирах, офисах, ресторанах, медицинских учреждениях, — делится с нами Константин Медведев. — Чтобы качественно описывать и документировать такие продукты и не терять к ним интерес, нужно любить не только тексты, но и физику в широком ее смысле. Все технические писатели компании «Тион» заканчивали университеты по техническим специальностям. Например, факультет автоматики и вычислительной техники НГТУ, физико-технический факультет НГТУ и факультет информационных технологий НГУ. При этом, выполняя свои задачи, они не просто пишут то, что им диктуют разработчики. Они являются еще и техническими специалистами, которые не только разбираются в продукте на уровне его архитектуры, но и могут буквально разобрать и собрать его по винтикам.

Конференция длилась целый день с десяти утра до семи вечера. Организаторы DocFactor’17 поблагодарили ФИТ НГУ за помощь в проведении конференции, а также всех участников за то, что в воскресенье пришли послушать о том, как работают другие технические писатели Новосибирска. Конференция проводится второй год подряд. В прошлом году на ней было пять докладов и 80 участников, а в этом — уже восемь докладов и 110 участников. Кроме того, несколько десятков человек из других городов смотрели онлайн-трансляцию конференции на YouTube.

Текст: Вера Кузнецова

Редакция благодарит оргкомитет DocFactor’17 за помощь в подготовке материала