Техническая документация руководство it специалиста

Должностные инструкции IT отдела

В документе прописан круг должностных обязанностей ИТ-специалистов, перечень может варьироваться, в зависимости от сектора экономики, в котором работает компания, а также от размера организации и профиля ее деятельности. Документ составляется для конкретной должности с разграничением полномочий и позволяет качественно контролировать работу.

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

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

Техническая документация в разработке ПО: кто, зачем, когда и как описывает проект

Привет! Меня зовут Даша Григорьева, я технический писатель в компании 65apps. Мы занимаемся разработкой сложных мобильных решений, и моя задача — подготовка технической документации по проектам. Очень часто роль технического писателя бывает недооцененной в компании (не у нас, конечно). Поэтому я хочу рассказать, зачем компании-разработчику нужен такой специалист, что такое технический проект, чем он отличается от ТЗ и почему это все необходимо для разработки мобильного приложения.

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

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

Другой пример — государственные организации или организации, чья деятельность ограничивается или подчиняется законам и надзорным органам. Они обязаны осуществлять разработку ПО по всем правилам и с соблюдением всех стандартов. В таких проектах техническая документация, подготовленная по ГОСТам, — необходимое условие.
И разумеется, грамотно составленная и актуальная документация необходима для того, чтобы каждый участник в процессе разработки мог обращаться к документам, если возникают вопросы по конкретной задаче или по всей системе в целом.

Техническое задание и технический проект — два разных документа. Техническое задание отвечает на вопрос «что нужно сделать?», его составляет аналитик в самом начале проекта. Технический проект разрабатывает технический писатель. Этот документ создается после ТЗ и отвечает на вопрос «как нужно делать?».

Кто пишет техническую документацию

Обычно разработкой ТЗ занимается аналитик. Именно он общается с заказчиком / заинтересованным лицом и выявляет у него требования. В сложных случаях к процессу можно привлечь менеджера проекта, разработчиков, тестировщиков и других специалистов. Чем сложнее проект — тем больше требований к документации. Серьезные заказчики из крупных корпораций и госсектора требуют составлять документацию в соответствии с ГОСТами, а это задача очень трудоемкая, требующая внимательности к деталям и постоянной вовлеченности в процесс. И это не только ТЗ, но и технический проект, полностью описывающий все используемые в разработке решения, подходы и методологии. На него также распространяются ГОСТы. Подготовкой такой документации должен заниматься специалист — технический писатель.

Для крупных проектов иметь в штате технического писателя просто необходимо. Разработка решений для крупных заказчиков может длиться год и более, это довольно долгий срок. За это время возникает достаточное количество изменений, провоцирующих обновление документации. Кроме того, любая долгосрочная разработка ПО предполагает развитие. В этом случае актуальная техническая документация позволит снизить риски, закладываемые в работу исполнителей.

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

Кто такой технический писатель

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

Для этого он собирает информацию и материалы от участников проекта и документирует эти данные согласно требованиям заказчика, в том числе и в соответствии с ГОСТами. Речь идет о ГОСТ 19 «Единая система программной документации» и ГОСТ 34 «Информационная технология. Комплекс стандартов на автоматизированные системы». Также технический писатель следит за актуальностью технической информации, если это необходимо на длительных и сложных проектах.

Какая техническая документация нужна разработчику

Рассмотрим идеальный с точки зрения ГОСТа процесс разработки системы.
Все начинается с требований заказчика или заинтересованных лиц, которые необходимо выявить и обязательно зафиксировать в документе «Техническое задание».

Техническое задание — это документ, регламентирующий бизнес-цели, общее описание системы, объем работ, границы проекта, а также порядок разработки, оценки и приемки. Данный документ отвечает нам на вопрос «что нужно сделать?» и фактически является постановкой задачи.

Аналитик составляет ТЗ и согласует его со всеми заинтересованными сторонами. После того как собраны и утверждены все требования, можно приступать к созданию прототипов будущей системы и разработке программного обеспечения.

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

Технический проект — это совокупность документов, описывающих и обосновывающих все подходы, методы, архитектурные и технические решения, применяемые для создания системы. Например, в технический проект включают макеты интерфейсов, описание протоколов для интеграции со смежными системами и оборудованием, пользовательские сценарии, описание алгоритма и их формирование, структура серверов и баз данных, а также другие требования к системе и ее взаимодействию с другими внешними системами.
это далеко не все: существует много стандартов для написания технической документации, и для каждой страны они свои. В отечественных стандартах есть отдельно ГОСТ на создание автоматизированных работ и на программное изделие. Например, технический проект по ГОСТу 19 «Единая система программной документации» может включать в себя следующий перечень работ:

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

Соответственно, технический проект отвечает на вопрос «как нужно делать?» и именно его составляет технический писатель.

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

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

Когда составлять техническую документацию

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

Есть проекты, в которых важно иметь полную документацию до начала работ. Это касается решений с высокими требованиями к безопасности, соблюдению законодательства и т. д. Например, мобильные приложения для банков. В этом случае важно сначала продумать все детали системы (информационная безопасность клиентов и самого банка, соответствие законам). На это уйдет больше времени, но позволит избежать финансовых и репутационных рисков.

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

На сегодняшний день технический писатель не самая распространенная специальность, но для серьезной компании-разработчика такой сотрудник не менее важен, чем, например, аналитик.
Техническая документация обязательно разрабатывается для госзаказчиков, она необходима и для долгосрочных проектов, на которых с бОльшей вероятностью могут меняться подрядчики. Имеет смысл создавать технический проект для ноу-хау технологий и проектов высокой сложности — документация понадобится отделу QA, чтобы отличить баги и фич.

Главная

»

Информационные системы

»

Администрирование в ИС

»

Структура типовой эксплуатационной документации

Структура типовой эксплуатационной документации

1. Правила хранения и ведения документации.
2. Организационное обеспечение
2.1 Должностные инструкции администраторов
• Домена (рабочей группы)
• Сервера
• Рабочих станций
• Сетевой инфраструктуры
• Приложений
• Принтеров
• Системы резервного копирования и восстановления данных
• Системы информационной безопасности
2.2 Мероприятия по обеспечению защиты системы от:
• Несанкционированного доступа
• Заражения вирусными программами
• Физического повреждения оборудования
• Сбои операционной системы и приложений
2.3 Организация структуры каталогов
• Организация групп пользователей
• Описание прав и методов доступа
• Организация рабочих мест пользователей
3. Техническое обеспечение
3.1 Рабочие станции
3.1.1 Необходимая конфигурация
3.1.2 Рабочие карты рабочих станций (настройки)
3.1.3 Рекомендации по дальнейшему масштабированию
3.1.4 Журнал учета работ
3.2 Сервер
3.2.1 Необходимая конфигурация
3.2.2 Рабочие карты серверов (настройки)
3.2.3 Рекомендации по дальнейшему масштабированию
3.2.4 Журнал учета работ
3.3 Принтеры
3.3.1 Необходимая конфигурация
3.3.2 Рабочие карты рабочих принтеров (настройки)
3.3.3 Рекомендации по дальнейшему масштабированию
3.3.4 Журнал учета работ
3.4 Активное сетевое оборудование
3.4.1 Необходимая конфигурация
3.4.2 Рабочие карты сетевого оборудования (настройки)
• Локальные сети
• Сегменты
• Соединения
• Маршруты
• Протоколы
• Фреймы
3.4.3 Схема размещения
3.4.4 Схема трассировки
3.4.5 Рекомендации по дальнейшему масштабированию
3.4.6 Журнал учета работ
3.5 Кабельные системы
3.5.1 Топология
3.5.2 Характеристики кабельной проводки, стандарты
3.5.3 Схема жгутовки и разводки
3.5.4 Защита от электромагнитных излучений
3.5.5 Пожарная безопасность
3.5.6 Журнал учета работ
3.6 Вспомогательное оборудование
3.6.1 Источники бесперебойного питания
3-6.2 Кондиционеры
3.6.3 Электропроводка и заземление
3.6.4 Средства электробезопасности
3.6.5 Средства пожаротушения
3.6.6 Журнал учета работ
4. Методическое обеспечение
4.1 Методика мониторинга сети
4.2 Мониторинг ресурсов сервера
4.3 Мониторинг ресурсов рабочих станций
4.4 Мониторинг и контроль устройств хранения данных
4.5 Методика резервного копирования и восстановления данных
4.6 Методика антивирусной защиты
4.7 Методические инструкции пользователей
4.8 Методика защиты от несанкционированного доступа
5. Программное обеспечение
5.1. Сетевые операционные системы
5.1.1. Установка
5.1.2. Параметры
5.1.3. Настройка
5.1.4. Взаимодействие
5.2. Клиентская операционная система
5.2.1. Установка
5.2.2. Параметры
5.2.3. Настройка
5.3. Серверные приложения
5.3.1. Установка
5.3.2. Параметры
5.3.3. Настройка
5.4. Прикладное программное обеспечение
5.4.1. Установка
5.4.2. Параметры
5.4.3. Настройка
5.5. Специальное программное обеспечение
5.5.1. Программные средства резервного копирования и восстановления
данных
5.5.2. Программные средства мониторинга и управления сетевыми
ресурсами
5.5.3. Антивирусное программное обеспечение
5.6. Лицензии и ограничения операционных систем и прикладного
программного обеспечения
6. Информационное обеспечение
6.1. Обучение сотрудников и пользователей (планы и ведомости)
6.2. Формальные описания документооборота
6.3. Формальные описания бизнес процессов, поддерживаемых системой
6.4. Учебно-методические материалы
6.5. Техническая документация на оборудование и программные продукты.
6.6. Информационные материалы
6.7. Дистрибутивы операционной системы, прикладного программного
обеспечения, драйверы устройств, утилиты.
Начинается процесс документирования системы на самых ранних этапах ее проектирования. В комплект документации входят полностью все результаты предпроектных исследований, а также вся документация, полученная или разработанная на этапах проектирования и внедрения системы, (прежде всего, это
паспорт системы, разработанный по результатам внедрения). Кроме этого комплект документов должен содержать копии всех договоров, контрактов, счетов и документов на оплату, сопутствовавших проектированию и внедрению системы. Более того, документацию необходимо требовать от разработчиков и службы внедрения системного интегратора.

---

Друзья! Приглашаем вас к обсуждению. Если у вас есть своё мнение, напишите нам в комментарии.

Ниже представлен пример (образец) документа «Руководство пользователя«, разработанного на основании методических указаний РД 50-34.698-90.

Данный документ формируется IT-специалистом, или функциональным специалистом, или техническим писателем в ходе разработки рабочей документации на систему и её части на стадии «Рабочая документация».

Для формирования руководства пользователя в качестве примера был взят инструмент Oracle Discoverer информационно-аналитической системы «Корпоративное хранилище данных».

Ниже приведен состав руководства пользователя в соответствии с ГОСТ. Внутри каждого из разделов кратко приведены требования к содержанию и текст примера заполнения (выделен вертикальной чертой).

Разделы руководства пользователя:

1. Введение.
2. Назначение и условия применения.
3. Подготовка к работе.
4. Описание операций.
5. Аварийные ситуации.
6. Рекомендации по освоению.

1. Введение

В разделе «Введение» указывают:

1. область применения;
2. краткое описание возможностей;
3. уровень подготовки пользователя;
4. перечень эксплуатационной документации, с которой необходимо ознакомиться пользователю.

2. Назначение и условия применения Oracle Discoverer Plus

В разделе «Назначение и условия применения» указывают:

1. виды деятельности, функции, для автоматизации которых предназначено данное средство автоматизации;
2. условия, при соблюдении (выполнении, наступлении) которых обеспечивается применение средства автоматизации в соответствии с назначением (например, вид ЭВМ и конфигурация технических средств, операционная среда и общесистемные программные средства, входная информация, носители данных, база данных, требования к подготовке специалистов и т. п.).

3. Подготовка к работе

В разделе «Подготовка к работе» указывают:

1. состав и содержание дистрибутивного носителя данных;
2. порядок загрузки данных и программ;
3. порядок проверки работоспособности.

4. Описание операций

В разделе «Описание операций» указывают:

1. описание всех выполняемых функций, задач, комплексов задач, процедур;
2. описание операций технологического процесса обработки данных, необходимых для выполнения функций, комплексов задач (задач), процедур.

Для каждой операции обработки данных указывают:

1. наименование;
2. условия, при соблюдении которых возможно выполнение операции;
3. подготовительные действия;
4. основные действия в требуемой последовательности;
5. заключительные действия;
6. ресурсы, расходуемые на операцию.

В описании действий допускаются ссылки на файлы подсказок, размещенные на магнитных носителях.

5. Аварийные ситуации

В разделе «Аварийные ситуации» указывают: 1. действия в случае несоблюдения условий выполнения технологического процесса, в том числе при длительных отказах технических средств; 2. действия по восстановлению программ и/или данных при отказе магнитных носителей или обнаружении ошибок в данных; 3. действия в случаях обнаружении несанкционированного вмешательства в данные; 4. действия в других аварийных ситуациях.

6. Рекомендации по освоению

В разделе «Рекомендации по освоению» указывают рекомендации по освоению и эксплуатации, включая описание контрольного примера, правила его запуска и выполнения.

УТВЕРЖДАЮ:

_______________________________

[Наименование должности]

_______________________________

_______________________________

[Наименование организации]

_______________________________

_______________________/[Ф.И.О.]/

«______» _______________ 20___ г.

ДОЛЖНОСТНАЯ ИНСТРУКЦИЯ

Специалиста отдела информационных технологий

1. Общие положения

1.1. Настоящая должностная инструкция определяет и регламентирует полномочия, функциональные и должностные обязанности, права и ответственность специалиста отдела информационных технологий [Наименование организации в родительном падеже] (далее — Компания).

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

1.3. Специалист отдела информационных технологий подчиняется непосредственно [наименование должности непосредственного руководителя в дательном падеже] Компании.

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

1.5. Специалист отдела информационных технологий должен знать:

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

1.6. Специалист отдела информационных технологий в своей деятельности руководствуется:

• требованиями законодательства РФ;
• локальными актами и организационно-распорядительными документами Компании;
• правилами внутреннего трудового распорядка;
• правилами охраны труда и техники безопасности, обеспечения производственной санитарии и противопожарной защиты;
• указаниями, приказаниями, решениями и поручениями непосредственного руководителя;
• настоящей должностной инструкцией.

1.7. В период временного отсутствия специалиста отдела информационных технологий его обязанности возлагаются на [наименование должности заместителя].

2. Должностные обязанности

Специалист отдела информационных технологий выполняет следующие должностные обязанности:

2.1. Обеспечивает достоверность, защиту информации и своевременность ее предоставления.

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

2.3. Осуществляет информационно-техническую поддержку.

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

2.5. Обеспечивает аудио-, видео- и компьютерное обслуживание.

2.6. Разрешает или ограничивает доступ к информации, определяет порядок и условия такого доступа.

2.7. Передает информацию другим лицам по договору или на ином установленном законом основании.

2.8. Создает информационные системы и обеспечивает доступ к содержащейся в них информации.

2.9. Внедряет новые информационные технологии в деятельность организации.

2.10. Анализирует потребности организации в дополнительных средствах вычислительной техники и обработки информации.

2.11. Обеспечивает бесперебойную работу оборудования и пользователей.

2.12. Выявляет и оперативно устраняет перебои в работе оборудования.

2.13. Осуществляет анализ и учет случаев отказа системы.

2.14. Ведет учет и составляет отчетность о проделанной работе.

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

2.16. Устраняет неисправности в программном обеспечении компьютерной и офисной техники.

2.17. Обеспечивает бесперебойное функционирование системы и принимает оперативные меры по устранению возникающих в процессе работы нарушений.

2.18. Анализирует характеристику технических устройств, средств электросвязи и программного обеспечения.

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

3. Права

Специалист отдела информационных технологий имеет право:

3.1. Знакомиться с проектными решениями руководства организации, касающимися его деятельности.

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

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

3.4. Требовать от руководства организации оказания содействия в исполнении своих должностных обязанностей и прав.

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

4. Ответственность

Специалист отдела информационных технологий несет административную, дисциплинарную и материальную (а в отдельных случаях, предусмотренных законодательством РФ, — и уголовную) ответственность за:

4.1. Невыполнение или ненадлежащее выполнение служебных указаний непосредственного руководителя.

4.2. Невыполнение или ненадлежащее выполнение своих трудовых функций и порученных ему задач.

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

4.4. Недостоверную информацию о состоянии выполнения порученной ему работы.

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

4.6. Не обеспечение соблюдения трудовой дисциплины.

5. Условия работы

5.1. Режим работы специалиста отдела информационных технологий определяется в соответствии с правилами внутреннего трудового распорядка, установленными в Компании.

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

6. Порядок пересмотра должностной инструкции

6.1. Должностная инструкция пересматривается, изменяется и дополняется по мере необходимости, но не реже одного раза в пять лет.

6.2. С приказом о внесении изменений (дополнений) в должностную инструкцию знакомятся под расписку все работники организации, на которых распространяется действие этой инструкции.

С инструкцией ознакомлен ______/____________/ «__» _______ 20__ г.

(подпись)