Приглашаем в Intel Technical Writing School всех настоящих лингвистов – любителей и исследователей естественных и компьютерных языков, графоманов и фанатов оксфордской запятой! Мы расскажем вам о том, что такое техническое писательство, какие существуют стандарты в англоязычной (читай: интернациональной) технической документации для программного обеспечения, и какими знаниями и навыками надо обладать, чтобы работать техническим писателем в Intel.

В рамках Intel Technical Writing School мы проведем серию вебинаров и воркшопов, посвященных разработке контента (content design) и технологическим решениям по его поддержке (system design).

Программа курса:

• Введение в профессию технического писателя
• Язык технической документации. Особенности написания технических текстов на английском языке
• Основные типы документов и требования к ним. Онлайн и офлайн форматы, контекстная справка
• Информационная архитектура (принципы минимализма, структуризация контента, DITA, инфотипы)
• Инструменты и процессы разработки документации. Обзор современных инструментов, используемых Intel
• Принципы UX в технической документации. Работа с типами пользователей, их мотивациями и целями. Аналитика
• Работа с документацией в проектах с открытым исходным кодом (open source)
• Бонус: Как пройти интервью на позицию ‘технический писатель’ в Intel

Этот курс рассчитан на студентов с высоким уровнем владения английским языком (программа включает лекции на английском).

Следующая встреча: 27 февраля (суббота) в 12:00

Основы разработки документации для open source проектов

Спикер: Андрей Зайцев, Senior Technical Writer @ Intel

Обзор доклада: Одна из популярных тенденций в современном мире разработки программного обеспечения – создание проектов с открытым исходным кодом (open source). Данный доклад представляет собой обзор процесса разработки документации для таких проектов. Вы узнаете о концепции open source, различных видах проектов (полностью открытый/частично/контролируемый), а также о специфике процесса разработки документации в мире open source, получите представление о наиболее популярных форматах и инструментах для создания и публикации документации.

Doxygen: обзор инструмента для автоматической генерации документации из исходного кода

Спикер: Николай Тюкаев, Technical Writer @Intel

Обзор доклада: Doxygen – это инструмент для автоматической генерации документации из исходного кода, поддерживающий такие языки программирования, как, например, С/C++, Java, Python, PHP. В качестве выходных форматов Doxygen генерирует HTML и PDF. Из данной презентации вы узнаете, как начать использовать Doxygen в вашем проекте, получить документацию из исходного кода и настроить выходной формат под ваши нужды.

Практикум: работа с документацией в open source

Спикер: Екатерина Мехнецова, Technical Writer @ Intel

Обзор доклада: Вас ждет живая демонстрация цикла работы с open source документацией на примере тестового проекта в GitLab. У всех желающих будет возможность попробовать себя в качестве разработчика такой документации.

Предыдущие темы лекций:

• Texнический писатель: особенности профессии
• Контент-стратегия: Новый уровень экспертиз
• Основные форматы технической документации для ПO
• Язык технической документации. Особенности написания технических текстов на английском языке.
• Информационная архитектура и структурирование контента
• Single-sourcing или технология единого источника
• Основы архитектуры DITA
• Компонентные системы управления содержимым (CCMS)