|
Трудовые действия
|
Изучение целевой аудитории технической документации на программные интерфейсы (далее - API) и средства разработки приложений (далее - SDK)
|
|
Изучение темы технической документации с точки зрения целевой аудитории и с учетом ее информационных потребностей
|
|
Составление подробного плана технической документации и его согласование с экспертами
|
|
Создание описаний интерфейсов (API) и средств разработки приложений (SDK), составление технической документации, подготовка иллюстраций
|
|
Настройка правил автоматической проверки документации на соответствие требованиям качества
|
|
Составление и отладка программ-примеров
|
|
Согласование технической документации с экспертами
|
|
Публикация контента технической документации в виде информационных продуктов, отвечающих заданным требованиям
|
|
Необходимые умения
|
Опрашивать экспертов и анализировать полученные сведения
|
|
Исследовать API и SDK на тестовом стенде
|
|
Исследовать техническую документацию, извлекать из нее сведения, необходимые для решения поставленной задачи
|
|
Осваивать языки программирования, интерфейсы прикладного программирования, протоколы обмена данными
|
|
Составлять и отлаживать несложные программы и тестовые примеры
|
|
Разрабатывать требования к информационному продукту
|
|
Оценивать количество рабочих часов, необходимых для выполнения полученного задания
|
|
Составлять календарный план выполнения полученного задания
|
|
Получать замечания экспертов и вносить исправления в документ
|
|
Преобразовывать технический документ в различные выходные форматы (PDF, форматы текстовых процессоров, HTML, форматы электронной справки, форматы электронных книг)
|
|
Необходимые знания
|
Современное состояние индустрии информационных технологий, основные подходы и тенденции
|
|
Перечень наиболее распространенных современных аппаратных платформ, сферы их применения, основные технические характеристики
|
|
Перечень наиболее распространенных современных операционных систем, сферы их применения, основные технические характеристики
|
|
Принципы функционирования современных телекоммуникационных сетей
|
|
Наиболее распространенные современные архитектурные решения, применяемые при проектировании программных средств и компьютерных систем различного назначения
|
|
Перечень наиболее часто применяемых современных стандартов в области системной и программной инженерии, основные принципы, заложенные в эти стандарты
|
|
Перечень наиболее распространенных современных методологий разработки программ и систем, основные принципы, заложенные в эти методологии
|
|
Программирование в объеме программы технического вуза
|
|
Основные типы документов, адресованных разработчикам продукции в сфере информационных технологий, особенности этих документов
|
|
Общие требования к структуре технического документа
|
|
Способы изложения материала, наиболее распространенные в современной документации разработчика
|
|
Информационно-справочный и информационно-поисковый аппарат документа
|
|
Основные виды авторской разметки текста технической документации
|
|
Примеры документации API и SDK, которые в профессиональной среде специалистов по информационным технологиям считаются наиболее удачными
|
|
Наиболее распространенные современные языки структурированного описания API и моделей данных
|
|
Наиболее распространенные языки аннотирования программного кода, а также инструменты генерации описаний API и SDK
|
|
Основные стандарты оформления технической документации
|
|
Основные электронные форматы информационных продуктов и особенности их использования
|
|
Перечень лидирующих инструментальных средств, их назначение, основные функциональные возможности, сильные и слабые стороны, способы применения: средства для набора текста (текстовый процессор, XML-редактор), текстовые редакторы с поддержкой набора исходного кода, средства подготовки снимков экрана, средства генерации документации, средства преобразования документов в выходные форматы
|
|
Другие характеристики
|
-
|