Оформить заявку на обучение

Разработка технической документации в современной IT-компании (использование корпоративного стандарта документации) (дистанционно)

Разработка технической документации в современной IT-компании (использование корпоративного стандарта документации) (дистанционно)

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

Под термином «техническая документация» мы будем в дальнейшем подразумевать пользовательскую  документацию к программным продуктам.
Корпоративный стандарт – набор обязательных требований, предъявляемых к технической документации, создаваемой в конкретной компании. Эти требования могут касаться описания отдельных элементов программного продуктов, оформления текста, структурирования документа, стиля изложения и т.д.

Зачем нужен корпоративный стандарт в современной IT-компании?

Основные его функции таковы:

  • Корпоративный стандарт позволяет унифицировать техническую документацию, создаваемую в компании. Это особенно важно при долгосрочной работе с постоянными клиентами. Пользователь, уже встречавшийся с документацией компании ранее, и соответственно, знакомый со стилем описания, стандартной структурой, оформлением и т.д., будет увереннее себя чувствовать при работе с очередным документом.
  • Корпоративный стандарт даёт понять заказчику или пользователю, что за конкретным отдельным документом стоит не только авторитет отдельно взятого технического писателя, но и всей компании. Кроме того, удачно разработанный корпоративный стандарт документации повышает авторитет компании в глазах пользователя.
  • Корпоративный стандарт облегчает работу самого технического писателя, предлагая ему готовые решения в плане структуры, стиля и оформления. Стандарт обязателен к исполнению и прямо предписывает, что техническую документацию следует писать «так и не иначе». Таким образом, стандарт экономит время и усилия технического писателя, позволяя ему уделить больше внимания собственно содержанию документа.

Откуда берётся корпоративный стандарт?

Как правило, он является результатом накопленного опыта по составлению документации, и кроме того базируется на стандартах компании Microsoft и ГОСТ. Хороший корпоративный стандарт так же  учитывает лучшие образцы документации к западным и отечественным программным продуктам.
Кто составляет корпоративный стандарт? В идеальной ситуации, разработкой стандарта занимается опытный технический писатель, работающий с документацией компании, после чего стандарт согласовывается с руководством компании. Это необходимо для того, чтобы учесть специфику компании и разрабатываемых ею программных продуктов.


Цель курса


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

  1.  Шаблоны стилей и создание документов на их основе на примере документов MS Word. 
  2. Описание отдельных элементов пользовательского интерфейса и стандартных действий пользователя в технической документации. 
  3. Стиль написания пользовательской документации в компании: тон и стиль изложения, использование терминологии, пунктуации и т.п. 
  4. Состав и структура документации различных типов. 
При составлении данного курса мы ориентировались главным образом на составление технической документации на русском языке, хотя в отдельных местах будут приводиться англоязычные аналоги.

Стоимость курса: 4490 руб. 


Возврат к списку

Оформить заявку на обучение