Обучающий курс

Краткое видео по проекту

Текущая ситуация

Здравствуйте, меня зовут Вожегов Дмитрий, сейчас я работаю начальником аналитического отдела в крупной it-компании, а раньше преподавал разработку и проектирование центральных процессоров, программирование, занимался наукой и совместно с компанией NVIDIA переводил руководства по программированию на С++ CUDA и "продвигал" вычисления на GPU. При этом всегда моя работа была тесно связана с разработкой и экспертизой технической документации по аппаратному и программному обеспечению.

Уже несколько лет меня, моих коллег и другие it-компании беспокоит проблема, связанная со значительным удорожанием проектов по проектированию, разработке, доработке и сопровождению программных и аппаратных систем во всех отраслях: в образовании, здравоохранении, оборонной промышленности и т.д. Одной из причин неэффективности и нецелесообразности доработки аппаратного и программного обеспечения является отсутствие качественной технической документации, к которой привёл дефицит ведущих технических писателей на рынке труда.

Как показала практика, ситуация не улучшается. К нам регулярно приходят предложения работы техническими писателями-аналитиками от разных компаний. И нам самим всё сложнее найти нужного специалиста. За полгода активного поиска можно не встретить ни одного специалиста, выполнявшего данную роль на предыдущих местах работы либо специалиста только на 50-60% соответствующего профилю профессии ведущий технический писатель. Иногда попадаются ведущие специалисты из других областей (главные инженеры, ведущие бизнес-аналитики), готовые попробовать взять на себя ответственность и примерить роль ведущего технического писателя в it-компании. Но из-за гигантского стека технологий, отсутствия информации по готовым технологическим решениям разработки и выпуска документации и непонимания со стороны коллег, они быстро возвращаются к предыдущей деятельности или уходят в смежные отрасли.

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

Руководители it-компаний часто недооценивают пользу хорошей документации, особенно применяя новые методологии разработки программного обеспечения, в которых говорится, что документация не так важна, как продукт. А значит работа технического писателя не так важна, как работа программиста или аналитика, и должна стоить меньше.

Мы считаем, что документация – это важная часть продукта, а технический писатель – это один из ключевых специалистов, от которого зависит скорость разработки, доработки, внедрения и поддержки программного и аппаратного обеспечения. Качественное техническое задание минимизирует сроки и риски проекта. Качественная проектная документация, позволяет разработчикам и дизайнерам быстро начать разработку программного обеспечения, в минимальные сроки обеспечив потребности пользователей. Качественная эксплуатационная документация ускоряют процессы настройки и использования программного обеспечения. Сотрудники технической поддержки, администраторы и DevOps-инженеры с помощью технической документации оперативно находят и исправляют неисправности в программном и аппаратном обеспечении. Хорошая документация увеличивает долю успешных it-проектов в любой отрасли (образование, здравоохранение, оборонная промышленность и т.д.), а, следовательно, позволяет достигать самых высоких целей и признания окружающих.

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

Например, чтобы спроектировать гибкую структуру пакета документов, в которой есть постоянные документы, а есть документы, меняющиеся из-за правок и замечаний заказчика каждый день, содержащие множество ссылок и зависимостей, технический писатель должен применять принципы SOLID - единственной ответственности, разделения интерфейсов, инверсии зависимостей. Для документирования API технический писатель должен знать основные паттерны проектирования и интеграции информационных систем. Для запуска документирования устройств или информационных систем ещё до их окончательной разработки, технический писатель должен знать UML и понимать, что написано в задачах системных аналитиков. Для участия в предпроектном обследовании – знать нотации, применяемые бизнес-аналитиками (BPMN, EPC, IDEF). Т.к. хороший документ – это коллективный труд, то ведущему техническому писателю приходится много общаться с заказчиком, аналитиками, руководителями проектов и т.д. и отстаивать свою позицию. Без жёсткого продавливания своих интересов, создать качественный процесс разработки и выпуска документации - утопичная задача. Все вокруг будут выдавать некачественный материал, на основе которого не разработать хорошую документацию.

Наши предложения

Давайте подведём итог и ещё раз озвучим проблему. Дефицит ведущих технических писателей значительно сокращает срок службы программного и аппаратного обеспечения, делает их сопровождение и доработку дороже, чем выполнение разработки «с нуля». Кроме того, it-компании тратят огромные ресурсы на поиск, обучение и удержание редких специалистов, соответствующих уровню ведущих технических писателей. Но они всё равно уходят на другие должности. Если ситуация не изменится, то наступит день, когда мы перестанем разрабатывать качественную техническую документацию сами, а некачественную передадим на разработку в другие страны.

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

В основу объединения it-компаний и создания сообщества мы хотим заложить обучающий курс. Курс станет инфраструктурой, на основе которой любая it-компаниям, испытывающая потребность в ведущих технических писателях, сможет за 3-4 месяца обучить обычных технических писателей, системных и бизнес-аналитиков уровня middle до ведущих технических писателей. Также курс позволит:

значительно снизить затраты it-компаний на поиск, обучение и удержание таких экзотических специалистов, как ведущие технические писатели;
дать учебным заведениям актуальные материалы для включения в учебные программы it-специальностей;
повысить объём русскоязычных ресурсов по эффективной разработке технической документации;
показать привлекательность профессии технический писатель для молодых специалистов, тех, кто решил сменить свою специализацию и образовательных площадок;
избавиться от стереотипа, что технический писатель – это устаревшая и скучная профессия для людей, не желающих развиваться, а все курсы и книги для технических писателей о Word и ГОСТах;
небольшими инвестициями форсировать прогресс во всех областях, где идёт активное внедрение it-технологий (образование, медицина и т.д.).

Чтобы минимизировать риски, наладить доверие и оценить заинтересованность it-компаний и it-сообщества в решении озвученных проблем, мы создавали небольшой исследовательский проект и запускали сбор средств только на два модуля данного курса – «Вводный модуль» и «Разработка технического задания».

План всего курса приведен в данном файле. Состав курса - это то, чем мы занимаемся каждый день, в чём мы накопили много опыта, и по чему мы можем провести деловые игры, с реальными задачами.

Если вам понравилась структура нашего курса, и вы хотите самостоятельно его разработать, тогда свяжитесь с нами, мы будем рады поделиться опытом и принять участие в вашем проекте. Если качественный курс для обучения ведущих технических писателей выйдет у кого-то другого, мы будем рады его использовать на платной основе для регулярного обучения своих специалистов даже если стоимость будет больше 100 т.р. Но это не значит, что мы полностью откажемся от своего курса, т.к. верим в здоровую спортивную конкуренцию, которая ведёт к взаимоуважению, дружбе и качественному прогрессу любой области знаний.

Стоимость и сроки разработки

Мы не рассчитываем, что данный проект принесёт нам прибыль. На анализ рынка, изучение краудфандинговых платформ, запись видео и т.д. мы потратили больше, чем планировали собрать на исследовательский проект.

Почему мы не использовали Краудфандинговые платформы

Мы создавали проект на самых крупных краудфандинговых платформах РФ. Мы просмотрели инструкции и прошли обучение на этих платформах. Основной упор в обучении был на доверие. Без доверия никто не присоединится к проекту. Именно поэтому платформы настоятельно рекомендовали записать ролик с приветствием, добавить инфографику и т.д.

Мы всё сделали в соответствии с правилами платформ и обучающими материалами. Но после отправки проекта на модерацию на самой крупной платформе, оказалось, что видео-приветствие не запускается. Дальше выяснилось, что и инфографика не работает. И это всё после очень большого объёма проделанной работы. Мы связались с технической поддержкой платформы, уточнили, что наша целевая аудитория it-шники, у которых неработающее видео и некорректно отображающиеся материалы вызовут негатив. It-шники могут и в консоль браузера залезть и понять, что это проблема платформы. Маловероятно, что это добавит доверия. Наоборот, и у нас проект не будет успешным, и платформа не получит свою комиссию.

На это техническая поддержка нам ответила - обучающие материалы устарели, мы отключили, показанный на них функционал. Спасибо, что были внимательны при обучении, мы добавим информацию о том, что не работает. Информацию о проблемах с видео передадим нашим специалистам.

Даже тут мы столкнулись с большими потерями времени из-за неактуальной документации. Из-за такого отношения к проектам, инвесторам, документации, мы решили уйти с площадки и опубликовать информацию о проекте на личном ресурсе.

Благодарности

В первую очередь большое спасибо руководителю отдела разработки технической документации Николаю Юрьевичу Раку, за его старания довести до заказчиков и коллег необходимость разработки качественной технической документации.

Спасибо всем it-компаниям, архитекторам, разработчикам, инженерам, которые документируют спроектированные и разработанные решения, продлевая их жизнь.

Спасибо всем разработчикам Open Source приложений, которые использовались при подготовке проекта: Inkscape – за создание векторной графики, Gimp – за редактирование растровой графики, Synfig Studio – за создание анимации, Audacity – за редактирование аудио, OpenShot – за создание видео.

Спасибо дочке Вероничке за прототип лягушки, которая машет всем в шапке и описании проекта.