Клуб технических писателей

Инструкция по написанию постановки

maria.voronyuk
13 мая 2015, 12:19

Здравствуйте коллеги! Возникла необходимость написать некую инструкцию по созданию/написанию постановки задачи. Необходимо чтобы постановка была понятна и программисту и руководителю и юристу и т.д. Хочу узнать есть ли в Вашей организации подобные инструкции написания документа, если есть хочу обсудить с Вами, с чего начать? что учесть? как вообще к вопросу подойти по созданию инcтрукции? 

На сегодняшний день выделяю несколько основных пунктов, которые должны быть в постановке:

  • общее описание вопроса/проблемы
  • где потребуются изменения (в программном обеспечении, в бизнес-объекте, в базе данных и т.п.)
  • как работает сейчас*
  • как должно работать после изменений* 
  • техническая часть (что конкретно разработчик должен добавить в ПО, БО, БД и т.д)
  • технологическая часть 
  • примеры расчётов* (или любые другие примеры)
  • приложения
* - данных пунктов может не быть, зависит от поступившей задачи.
4 комментария
Подписаться на комментарии к посту

Мария, а чем Вас не устраивают типовые документы технического и частного технического заданий?

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

Может есть смысл вынести "его" часть в другой профильный документ?

maria.voronyuk
14 мая 2015, 13:47

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

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

Мария, спасибо! Очень интересно узнать, что у Вас получилось. Хотя задача для меня и не ежедневная, но время от времени ее приходиться решать :)

Наверное Вы знаете о перечне проектных документов из ГОСТ 34.201-89; можете посмотреть в нем уже устоявшийся комплект из описаний функций, оргструктур, задач и т. д.

Андрей Пшеничнов
18 мая 2015, 23:32

Мне бы тоже было интересно увидеть какой проучился процесс.