Технический писатель
0 0
Забронировать курс
-
Аннотация
-
Описание образовательной программы
Успешное окончание обучения по программе курса позволит специалистам:
Знать
• основные разновидности научно-технических документов
• основные стандарты оформления текстовых документов
• языки разметки (HTML, XML)
• язык описания стилей CSS
• основные форматы графических файлов и особенности их использования
• общепринятые требования к руководству по эксплуатации технического средства и к руководству пользователя программного средства
• основные особенности стиля изложения технической документации
Уметь
• работать в современном текстовом процессоре
• составлять научно-технический текст, придерживаясь композиционных и стилистических правил, присущих научно-техническому стилю
• настраивать программу-редактор для работы с документами, размеченными в соответствии с правилами заданного приложения языка XML
• составлять несложные стили на языке CSS и отлаживать их преобразовывать рисунки (в том числе представленные в векторных форматах) в форматы PNG и JPEG
• разрабатывать план документа и согласовывать его с экспертами
• составлять информационные текстовые файлы
• разрабатывать руководство пользователя несложного программного средства или краткое руководство по эксплуатации несложного технического средства
• анализировать замечания экспертов и вносить исправления в документ
Владеть
• навыками по разработке структуры документа и ее согласованию с экспертами
• навыками по подбору дополнительных источников информации
• навыками по отбору материала из имеющихся источников и его переработке для включения в новый контекст
• навыками по набору основного текста документа и служебных последовательностей символов в соответствии с правилами заданного языка разметки
• навыками по подготовке рисунков для включения в документы, размеченные в соответствии с правилами языка разметки HTML или какого-либо приложения языка XML
• навыками по изучению документируемой продукции, получению необходимых для разработки документа сведений о ней
• навыками по составлению подробного плана, текста документа, подготовке иллюстраций, и его согласованию с экспертами
Целевая аудитория
ИТ-специалисты
Разработчики технической документации
Технические писатели
Студенты технических специальностей
Содержание
Роль документации в разработке ПО
Профессиональный стандарт. Цели и задачи технического писателя
Общие требования к технической документации
Основные принципы и правила написания технического текста:
4.1. понятие о научно-техническом стиле, его основные правила;
4.2. план документа;
4.3. иллюстрации и дополнения к тексту;
4.4. общая композиция документа.
Процесс разработки технического документа:
5.1. определение цели и задач документа,
5.2. разработка плана и модели документа,
5.3. выбор структуры документа,
5.4 подбор дополнительных источников информации;5.5. отбор материала из имеющихся источников,
5.6. написание текста документа,
5.7. компоновка и редактирование документа,
5.8. согласование документа с экспертами.
Основные виды технической документации в области разработки ПО и особенности их создания:
6.1. техническое задание, спецификация требований,
6.2. проектная документация,
6.3. исходный код и документация по API,
6.4. пользовательская документация.
Основные стандарты в области документирования ПО:
7.1. Серия стандартов ГОСТ 2,
7.2. Серия стандартов ГОСТ 19,
7.3. Серия стандартов ГОСТ 34,
7.4. Международные стандарты.
Практические работы:
- Разбор примера технического задания и спецификации требований.
- Разбор примера описания API приложения.
- Разбор примера пользовательской документации.
- Определение и отбор источников информации.
- Описание структуры пользовательского интерфейса.
- Описание варианта использования приложения.
-
Получаемый документ
-
Необходимая подготовка
Приветствуется наличие технического образования, опыт разработки технической документации или работы в ИТ-сфере.
-
Цель курса
Формирование знаний и умений, необходимых для написания документов технического назначения в области разработки ПО.
0 отзывов
Об этом курсе отзывов пока нет. Будьте первым.
Чтобы оставить отзыв необходимо авторизоваться на сайте или зарегистрироваться.