Пользовательская документация – неотъемлемая часть качественных программных продуктов. Наличие хорошей пользовательской документации означает снижение затрат на техническую поддержку пользователей, а также улучшает имидж как самого продукта, так и его разработчиков. Профессиональный подход к разработке пользовательской документации давно стал одним из признаков успешных IT-компаний.

Из этого курса вы узнаете:

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

Для прохождения курса вам потребуется:

• Доступ в интернет.
• Электронная почта для общения с преподавателем.
• Компьютер под управлением ОС Windows, предпочтительно Vista или 7. Можно использовать и другие ОС (Linux, Apple), но это сильно сузит наши возможности, т.к. курс ориентирован в первую очередь на разработку документации для программ под Windows.
• Установленная программа Microsoft Word 2003 или 2007. Если нет возможности использовать Microsoft Word, можно использовать Open Office.org Writer или, если вы имеете аккаунт в Google, загружать материалы уроков на Google Documents.
• Права на установку программ на компьютере. Вам понадобится устанавливать программное обеспечение, которое мы будем описывать в документации, а также, возможно, специализированное программное обеспечение для разработки документации.

Автор и преподаватель курса – Старший технический писатель Лаборатории Касперского.

Скачать бесплатно первый урок Посмотреть первый урок онлайн

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

Урок 1. Введение в предмет. Этапы работы над пользовательской документацией

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

Урок 2. Виды и форматы пользовательской документации

Руководство пользователя, Руководство администратора, Руководство по установке, Быстрый старт, Контекстная справка. Форматы: DOC, PDF, HTML, CHM. Инструментарий технического писателя: универсальные текстовые процессоры, специализированные программы для разработки документации.

Урок 3. Структура документации

Оглавление как инструмент навигации и поиска информации в документе. Формирование структуры “от интерфейса” и “от задач”. Типовые структуры различных видов пользовательской документации. Нелинейность структуры электронных форматов документации.

Урок 4. Содержание и стиль документации

Составляющие технической документации: описания, инструкции, служебные разделы, контекстная справка. Основные стилистические свойства технических текстов: единообразие (стандартизация), полнота, точность, понятность, краткость.

Урок 5. Оформление документации

Применение шаблонов, стилей. Добавление в документацию скриншотов, пиктограмм, схем и других графических элементов. Инструментарий для подготовки изображений.

Урок 6. Средства навигации

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

Урок 7. Стандарты разработки технической документации

Роль стандартов в разработке документации. Стандарты, регулирующие структуру, содержание и оформление документации. Корпоративные стандарты. Государственный стандарт (ГОСТ).

Урок 8. Единый источник

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

Конкретные варианты реализация технологии: DocBook и DITA, Author-it.

Урок 9. О профессии “технический писатель”

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

Урок 10. Экзаменационная работа

Обобщение пройденного. Сдача экзамена.

Объем курса: 40 ак.ч.

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

Если Вас заинтересовал данный курс, предлагаем пройти предварительную регистрацию слушателя: