+7 (495) 646 11 75
Аутсорсинг аналитических работ в ИТ-проектах

Документация в ИТ-проектах

К списку публикаций
30.08.2017г.

Для чего нужна документация в ИТ-проектах?

Документация на автоматизированную систему (АС) – это Комплект взаимоувязанных документов, полностью определяющих технические требования к АС, проектные и организационные решения по созданию и функционированию АС (ГОСТ 34.003 90)

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

Трудности при эксплуатации системы могут возникнуть в случае, когда проектная документация отсутствует или разработана "формально" (предоставлен не полный пакет по составу и содержанию, который не полностью охватывает проектные и организационные решения по созданию и функционированию АС), при этом:

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

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

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

Примеры разрабатываемых документов

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

В качестве примера наиболее востребованных документов, разрабатываемых на всех проектных стадиях, можно привести следующие:

  • Требования к системе
  • Концепция создания информационной системы
  • Технические задания/Частные технические задания
  • Пояснительная записка к Техническому проекту
  • Описание автоматизируемых функций
  • Проектное решение
  • Описание организационного обеспечения
  • Описание информационного обеспечения
  • Описание организации информационной базы
  • Описание комплекса технических средств
  • Проектная оценка надежности системы
  • Технологическая инструкция
  • Руководство по администрированию
  • Руководство пользователя
  • Инструкция по эксплуатации КТС и другие

Использование проектной документации

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

Хранение документов

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

Актуализация документов

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

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

Что делать, если вы оказались в такой ситуации?

В случае, когда требуется восстановить (разработать) документацию на систему Вы можете это сделать самостоятельно (при наличии собственных технических специалистов) или привлечь специализированную компанию. Второй вариант на наш взгляд, более предпочтителен, так как специализированная компания, такая как "Бизнес-Азимут" например, обладает опытом реализации подобных проектов и может порекомендовать оптимально необходимый состав документации, предложить и обосновать использование соответствующих гостов для разработки документации при необходимости, а также предоставить гарантию на результаты своих работ в течение согласованного с Заказчиком срока. (подробнее об использовании требований ГОСТ вы можете прочитать здесь - ГОСТ 19 И 34 СЕРИИ ПРИ ОФОРМЛЕНИИ ДОКУМЕНТАЦИИ)

К списку публикаций
Закрыть
Связаться с нами
Закрыть
Сообщение отправлено

Наши менеджеры свяжутся с вами в ближайшее время