Определение целей и задач документирования

Смотрите:
Цели и задачи документирования при инициативной разработке
Цели и задачи документирования при разработке в интересах заказчика
Цели и задачи документирования при разработке в интересах пользователя (потребителя)

Цели и задачи документирования определяются видом разработки, а видов, согласно Р 50-605-80-93, всего три: инициативная разработка, разработка в интересах заказчика и разработка в интересах конечного пользователя. Каждому виду разработки (и документирования) присущи свои собственные цели и задачи. Редакция от 12.03.2021.

Создан 18.10.2009 12:39:50

Цели и задачи документирования при инициативной разработке

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

- Спортбокс.ру

Классическим примером инициативной разработки можно считать работы по созданию и сопровождению АС портала sportbox.ru (телеканала «Матч», бывш. «Россия 2», бывш. «Спорт»). Работа проводится силами заказчика (исполнителя) в интересах самого же заказчика (исполнителя). Приемки работы не ожидается - не принимать же ее у самого себя?

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

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

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

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

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

Цели и задачи документирования при разработке в интересах заказчика

Разработка в интересах заказчика - классический вариант разработки промышленной продукции. Разработчик разрабатывает, заказчик потребляет и эксплуатирует. Или не эксплуатирует (в части ремонта).

Цели и задачи документирования разработки, проводимой в интересах заказчика:

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

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

Цели и задачи документирования при разработке в интересах пользователя (потребителя)

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

Примечание - Под пользователем подразумевается не столько пользователь АС, пользователь ПС или пользователь СОИ, сколько «народно-хозяйственный» потребитель продукции, определенный соответствующим законом.

Цели и задачи документирования разработки, проводимой в интересах пользователя:

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