Курсы по технической документации

Максимизируйте эффективность архитектурных задач с помощью LLM.

Что такое генеративный ИИ и LLM. Как работают LLM (на пальцах): трансформеры, обучение, контекст. Обзор моделей: ChatGPT, Gemini, Claude, YandexGPT, Qwen — что выбрать архитектору? Этические аспекты, ограничения, галлюцинации.

Практика: Знакомство с интерфейсами LLM. Первые промпты: простые запросы. Сравнение ответов разных моделей. Анализ точности и полезности ответов.

Анатомия эффективного промпта: инструкция, контекст, примеры. Zero/One/Few-shot prompting. Управление ролью и форматом вывода (JSON, XML, Pydantic). Распространенные ошибки при составлении промптов.

Практика: Создание простых архитектурных описаний. Генерация краткой спецификации компонента. Задание роли ("архитектор", "эксперт по безопасности"). Тестирование влияния температуры и длины контекста.

Цепочка рассуждений (Chain-of-Thought) для принятия решений. Автоматизация создания ADR, RFC, README. Поддержание актуальной документации. Работа с доменной лексикой и стилем компании.

Практика: Генерация ADR по шаблону. Создание RFC на новую фичу. Автоматическое обновление README. Сравнение и доработка результатов разных моделей.

Генерация UML/C4-диаграмм (PlantUML, Mermaid). Описание архитектуры визуально и текстово. Согласование формата между разработчиками и заказчиками.

Практика: Генерация C4-контекстной диаграммы. Создание последовательности вызовов (sequence diagram). Перевод текстового описания в графический вид. Доработка и проверка корректности диаграмм.

Поиск проблем в существующем коде и архитектуре. Выявление дублирования, узких мест, антипаттернов. Использование ИИ для анализа соответствия стандартам.

Практика: Анализ фрагментов кода на безопасность и качество. Выявление антипаттернов в архитектуре. Проверка соответствия требованиям и гайдлайнам. Предложение альтернативных решений.

Как внедрить ИИ в ежедневную работу архитектора. База промптов для типовых задач. Шаблоны и менеджеры промптов. Работа с несколькими LLM-агентами.

Практика: Разработка библиотеки промптов под свои задачи. Автоматизация части архитектурного ревью. Интеграция с внутренними системами и Git. Обсуждение: как сделать процесс предсказуемым.

Безопасность и ответственность при использовании ИИ. Юридические, коммерческие и этические аспекты. Стратегии внедрения ИИ в архитектурные процессы. Обучение команды и работа с сопротивлением.

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

Критическое мышление при работе с ИИ. Возможности и ограничения современных инструментов.

Практика: Финальное задание: Получить архитектурную задачу. Сгенерировать ADR и RFC. Создать диаграммы и описание решения. Проанализировать потенциальные проблемы. Обсуждение решений, обмен опытом. Демонстрация полученных результатов.

Создавайте документацию, которая будет полезна и новичкам, и экспертам — от первых строк до релиза продукта! Курс раскрывает универсальные принципы разработки технической документации: от структуры до публикации. Вы освоите правила ясного изложения, форматирования и работы с MS Word, а также научитесь адаптировать контент под разный уровень подготовки читателей.

• Задачи технического писателя.
• Требования к документации.
• Создание документации как часть проекта по разработке ПО.
• Этапы разработки документации.
• Задание на разработку документации.
• Разновидности технических документов.
• Форма и структура документа, типы информации.
• Сценарии использования.
• Разработка функциональной части документа.
• Разработка справочных и описательных частей документа.
• Структурно-обусловленные разделы.
• Основные принципы изложения.
• Разбор примеров некачественных текстов.
• Оформление документов.
• Отличия русско- и англоязычной документации.
• Описания для специфических элементов.
• Обеспечение качества документации.
• Инструментарий и ресурсы для технического писателя.
• Рекомендации по работе с MS Word.
• Дополнительные онлайн-ресурсы и полезные инструменты.