Лаборатория технической документации (популярный курс)

На канале ТехДокЛаб публикуются материалы связанные с углублением знаний и развития навыков технического писателя: 1.  Представление (на основе Модуля 1): -   о компонентах системы управления качеством технической документации при производстве и эксплуатации продукции в сфере ИТ в соответствии с требованиями международных, государственных и корпоративных стандартов ; -   о системе государственной регистрации продукции в сфере ИТ. 2.  Знание: -   этапов жизненного цикла создания продукции в сфере ИТ и требования к их документированию в соответствии с современными стандартами и гибкими методологиями разработки программного обеспечения (на основе модулей 2, 3); -   системы классификации технической документации, требования к структуре, оформлению и стилевому изложению при разработке различных типов документов (на основе Модулей 3, 4); -   основ документирования и параметров контроля технических документов (на основе Модуля 4); -   инструментальные средства разработки документов (на основе Модуля 5). 3.  Умение: -   анализировать техническое задание для определения требований к разработке основного комплекта документов, включая их наполнение, исходя из требований к продукту; -   разрабатывать структурные элементы шаблонов документов, разрабатывать графический материал в соответствии с нотациями описания бизнес-процессов (BPMN); -   применять принципы упрощённого технического языка при разработке и рецензировании технической документации; -   разрабатывать шаблоны документов для перевода их в электронный вид с использованием современных средств разметки текста для их дальнейшей публикации в виде электронного руководства, электронных инструкций и встроенных справок в программный продукт. 4.  Владение навыками: -   А: создания и оформления различных типов технических документов в соответствии с установленными стандартами и стилевыми правилами с использованием современных инструментов; -   В: разработка и рецензирование сутевой части документа на основании требований и предоставленного материала, включая самостоятельную разработку и описание вариантов использования продукта сферы ИТ; -   С: управления знаниями о продукте с применением современных средств WiKi (Confluence); применения типовых приёмов промпт-инжениринга при решении практических задач в процессе профессиональной деятельности -   D: разработка технической документации на программные интерфейсы, подготовка обзоров, статей.

Технический писатель – молодая специальность, до этого все специалисты с инженерным образование участвовали в разработке различных видов документации. Появление профессионального стандарта ПС-197 выделило данную специализацию в отдельную профессию. Во многом, технический писатель сродни переводчику. Он должен уметь достаточно просто объяснить сложные вещи. Для этого необходима специальная подготовка для получения профессиональными навыками, таких, как: • работы с текстом — умение правильно структурировать текст, разбивать его на логические блоки. • создавать схемы и диаграммы в различных нотациях • работы с нормативной, правовой и другими видами информации. На этом канале будет размещаться информация обо всём, что касается работы системного аналитика и технического писателя (начиная от обзора требований регуляторов до применения нейросетей).