Documentat.io

Открытый и бесплатный онлайн-курс по технической документации в IT. После регистрации вы получите записи и материалы 12 лекций.

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

• Для сотрудников IT-компаний, которые хотят понять специфику процессов документирования — чтобы управлять этими процессами и участвовать в них.

• Для технических писателей, которые хотят лучше понимать роль своей работы в общей картине функционирования IT-компании.

• Для программистов, аналитиков, тестировщиков, менеджеров и для всех, кто создает техническую документацию в дополнение к своим основным служебным обязанностям.

Мы ожидаем, что слушатели этого курса имеют опыт работы в IT-компаниях и знакомы с процессами разработки ПО.

• Два определения технической документации. Документация — процесс или продукт? Документация как подмножество процессов управления знаниями. Документация как способ реализации проектной коммуникации. Какие задачи решаются технической документацией, а какие — нет. Что не является технической документацией. Примеры технических документов.

• Жизненный цикл технического документа. Постановка задачи, координация работы над документом, процессы вычитки и тестирования документации. Приемка и публикация технических документов. Критерии качества технической документации.

• Поддержка актуальности документации. Неизбежное «отставание» документации от реального положения дел.

• Инструменты создания, хранения и публикации технической документации. Требования к инструментарию от разных участников процесса документирования (читатели, авторы, рецензенты, менеджмент). Примеры инструментария: wiki-движки, системы документооборота общего назначения, специализированные системы создания пользовательской справки (AuthorIT, MadCap Flare). Разделение исходников и представления: генерация богатых форматов (DOCX, PDF, HTML) из текстовой разметки (Markdown, RST, XML). Понятие single sourcing.

• Методология docs-as-code. Хранение документации в системах контроля версий (Git, SVN) наравне с кодом. Легковесные языки текстовой разметки (Markdown, RST). Автоматизированные системы верификации, сборки и публикации контента. Непрерывная интеграция и непрерывное развертывание (continuous integration/continuous delivery) для документации. Рецензирование документации в методологии docs-as-code, переиспользование систем code review для документации.

• Индустриальные стандарты и рекомендации в области документации к ПО. Серии стандартов ЕСПД (ГОСТ 19.x), КСАС (ГОСТ 34.x). Англоязычные серии документационных стандартов ISO/IEC/IEEE.