Аннотация
Главная цель курса -- дать фундаментальные знания и практические навыки, соответствующие международным стандартам (ISO 26514) и современным трендам (Docs-as-Code, AI), для уверенного старта в профессии.
Формат
Лекции, практические workshops, разбор кейсов, групповая работа, защита финального проекта.
Аудитория
Начинающие технические писатели, стажеры, специалисты смежных профессий (разработчики, аналитики, специалисты тех.поддержки), желающие освоить современную и востребованную IT-профессию.
Требования к предварительной подготовке слушателя:
умение работать в программе WORD
Главная цель курса -- дать фундаментальные знания и практические навыки, соответствующие международным стандартам (ISO 26514) и современным трендам (Docs-as-Code, AI), для уверенного старта в профессии.
Формат
Лекции, практические workshops, разбор кейсов, групповая работа, защита финального проекта.
Аудитория
Начинающие технические писатели, стажеры, специалисты смежных профессий (разработчики, аналитики, специалисты тех.поддержки), желающие освоить современную и востребованную IT-профессию.
Требования к предварительной подготовке слушателя:
умение работать в программе WORD
Программа
1. Профессия Technical Writer в современной IT-индустрии
• Роль и место технического писателя в жизненном цикле разработки (SDLC).
• Ключевые навыки: hard skills (письмо, инструменты) и soft skills (коммуникация, empathy).
• Виды документации: пользовательская, API, системная, онбординг.
• Введение в ISO/IEC/IEEE 26514:2022:Значение стандарта для обеспечения качества.
• AI-инструменты в работе писателя:Обзор возможностей и ограничений. Важность конфиденциальности.
Практика: Анализ документации известных продуктов. Практическое задание по определению целевой аудитории
2. Принципы и стиль: Как писать ясно и понятно
• Принципы минимализма в техническом письме.
• Требования ISO 26514 к содержанию: точность, полнота, непротиворечивость.
• Примеры стилей технической документации (Microsoft, Google).
• Создание инструкций: алгоритмы, последовательность, повелительное наклонение.
• Глоссарий и консистентная терминология.
Практика: Рерайт сложного технического текста. Использование AI: Генерация черновика инструкции и его последующая «человеческая» редактура.
• Ключевые навыки: hard skills (письмо, инструменты) и soft skills (коммуникация, empathy).
• Виды документации: пользовательская, API, системная, онбординг.
• Введение в ISO/IEC/IEEE 26514:2022:Значение стандарта для обеспечения качества.
• AI-инструменты в работе писателя:Обзор возможностей и ограничений. Важность конфиденциальности.
Практика: Анализ документации известных продуктов. Практическое задание по определению целевой аудитории
2. Принципы и стиль: Как писать ясно и понятно
• Принципы минимализма в техническом письме.
• Требования ISO 26514 к содержанию: точность, полнота, непротиворечивость.
• Примеры стилей технической документации (Microsoft, Google).
• Создание инструкций: алгоритмы, последовательность, повелительное наклонение.
• Глоссарий и консистентная терминология.
Практика: Рерайт сложного технического текста. Использование AI: Генерация черновика инструкции и его последующая «человеческая» редактура.
3. Инструментарий: От MadCap Flare до GPT
• Философия Docs-as-Code:Git, Markdown, статические генераторы (Docusaurus, MkDocs).
• Проприетарные HATs (Help Authoring Tools): обзор возможнос
• Инструменты для графики (Snagit, Draw.io) и скринкастов.
• AI-инструменты:Классификация.
• Основы Prompt-инжиниринга для технических писателей.
Практика: Написание промптов для решения конкретных задач (напр., "сгенерируй описание для API-метода авторизации")
4. Проектирование архитектуры информации
• Основы информационной архитектуры.
• Ключевой артефакт: Проектная спецификация (Design Specification) по ISO 26514** (структура, шаблоны, навигация).
• Принцип единого источника (Single Sourcing) и многоканальная публикация.
Практика: Разработка проектной спецификации документации для вымышленного продукта с использованием AI( для определения структуры документов и возможных пользовательских сценариев).
5. Процесс разработки в Agile-команде
• Модель процессов по ISO 26514: Планирование -> Разработка -> Валидация -> Публикация -> Управление.
• Технический писатель в Scrum: митинги, спринты, бэклог.
• Сбор информации: интервью с экспертами (SMEs), работа с тестовыми стендами
Практика: Разработка чек-листа для валидации документации. Составление плана работы для гипотетического спринта.
6. Валидация, ревью и тестирование юзабилити.Метрики успеха
• Стратегии ревью: с экспертами (на точность), с коллегами (на ясность).
• Требования ISO 26514 к валидации: проверка на соответствие продукту и удобство использования.
• Методы тестирования с пользователями.
• Метрики успеха: Поиск, обратная связь, снижение нагрузки на поддержку.
Практика: Проведение парного ревью. Ролевая игра "Интервью с сердитым экспертом".
Использование AI:Использование LLM как первого рецензента для проверки грамматики и стиля
7. Специализированная документация: API и не только
• Документирование REST API: стандарт OpenAPI (Swagger).
• Требования ISO 26514 к описанию программных интерфейсов.
• Концепция доступности (a11y) для документации(Свойства документации: Перцептивность (Perceivable), Операбельность (Operable), Понятность (Understandable), Надёжность (Robust).
Практика: Анализ OpenAPI-спецификации и написание описания для эндпоинта.
8. Финальный проект.
Практика: Защита финальных проектов:** Презентация участниками созданного модуля документации (с обоснованием принятых решений в соответствии со стандартом).
Дальнейшее развитие: Сообщества (Write the Docs), ресурсы, курсы