Улучшаемые навыки
Техническое письмо
Структурирование документации
Работа с требованиями
Локализация текстов
Обеспечение качества документации
Техническая документация
User guides
MS Word
Confluence
Управление знаниями
Промпт-инжиниринг
ИИ
AI
Инструменты
MS Word
Confluence
Чему вы научитесь
01
Определять требования к документации и применять их на практике.
02
Формулировать информацию четко и без ошибок.
03
Организовывать документы по международным стандартам.
04
Находить и исправлять типовые ошибки в технических текстах.
05
Использовать продвинутые функции MS Word для автоматизации работы
06
Управлять знаниями о продукте с использованием Wiki-систем.
Программа курса
Отечественные и международных стандарты
Качество продукции в сфере ИТ
Среда Разработки качественной технической документации
Документация разработчиков
Государственная Регистрация продукции ИТ
02
Этапы создания документации и виды работ
Процессы жизненного цикла систем
Этапы создания документации
Виды работ документирования
Разработка документов
Техническая документация
Вид работы: документирование кода
Выбор инструментария
определение основной комплектности документации
Разработка Комплектности документации
03
Виды, типы и структура документов
Управление документацией ИТ
Документирование проектной деятельности
Шаблон документа
Разработка документа
Разработка типовых разделов документа
Use Case
Разработка диаграммы в нотации BPMN
04
Разработка и организация текста
Культура документирования
Информация как услуга
Стиль и читабельность технического текста
Работа с графическим контентом
Рецензирование и согласование
Выпуск и актуализация
Локализация
Языковые проблемы и УТР
05
Инструментарий и ресурсы для технического писателя
Современная экосистема инструментов техписа
Принципы docs-as-code (Git, Markdown, генераторы)
Интеграция в CI/CD-процессы
Эффективное взаимодействие с ИИ:
Промпт-инжиниринг для технических задач
Автоматизация рецензирования и правок
Генерация и оптимизация контента
Стратегия выбора инструментов под задачи проекта
06
Итого на курс часов: теория – 10 ч (62 %), практика – 6 ч (38 %)
Для кого
Системный аналитик
Технический писатель
Предварительная подготовка
Для качественного освоения программы требуется:
1. общее представление о разработке ПО;
2. опыт использования текстовых процессоров и других программных продуктов для работы с текстом.
