Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
А ещё по "внесеню изменений" подскажите
 
На пальцах, что и в каком месте документа нужно добавить, чтобы отразить сведения о внесённых в документ изменениях?
Например, я перименовал прежний раздел и подразделы в нём и добавил туда дополнительныq подраздел и пункты к нему.
В ЕСПД есть лист регистрации изменений и отдельный ГОСТ описывающий порядок внесения изменений.
Но меня интересует стандарт для документов, оформляемых в соответствии с серией "34" (кажется она, у меня на руках документ с рамочкой, в ЕСПД рамочек нет).
 
Серия 34 может иметь лист регистрации изменений.
Второй лист документа (первый - титульный) - Табличка "лист изменений" примерно следующего содержания:
[attachment=0:3jl2isy6]Лист_рег_изменений_ТЗ.png[/attachment:3jl2isy6]
 
Понял. В ЕСПД это в конце документа.
 
Цитата
caphook пишет:
Понял. В ЕСПД это в конце документа.
Konstantin не прав по расположению листа регистрации изменений. Для документов стадий эскизного, технического проекта и рабочей документации по 34 ГОСТ лист регистрации изменений должен быть последним листом документа.
 
Вопрос актуален.
Цитата
Konstantin пишет:
Серия 34 может иметь лист регистрации изменений.
это согласно чему?

Как насчет ТЗ по ГОСТ 34.602.89 : Изменения к ТЗ на АС оформляют дополнением или подписанным заказчиком и разработчиком протоколом. Дополнение или указанный протокол являются неотъемлемой частью ТЗ на АС. На титульном листе ТЗ на АС должна быть запись «Действует с … ».


Кто-нибудь разъяснить что это за "дополнение" и "протокол"?
 
На стадии разработки ТЗ лист регистрации изменений отражает работу по документу (по аналогии со спецификацией к разрабатываемому ПО, то есть этот лист фиксирует изменения ТЗ, как определённого продукта), когда документ ещё не подписан и проходит множественные согласования перед подписанием. Это не обязательный, это служебный лист, но он позволяет указать версию документа, которая в итоге подписывается сторонами. Вот написали ТЗ на 300 страниц, потом Исполнитель с Заказчиком начинают его согласовывать в неформальном ключе. Дополнительные протоколы на каждый чих писать - глупо (хотя можно заморачиваться, если делать на работе особо нечего), потому что ТЗ по факту ещё нет, пока оно не подписано. В этот лист вносится, в каком пункте что было изменено с повышением номера версии. В последнем номере версии указывается, что она финальная - на подписание.

Дополнения и протоколы, про которые речь в ГОСТ 34 - это те изменения, которые вносятся в ТЗ уже после подписания - они оформляются отдельным протоколом/дополнением со ссылкой на существующее ТЗ с версией.

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

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

Реальные ТЗ пишутся параллельно обследованию объектов автоматизации. скорость, управление проектами и т.п. - в нормальном бизнесе так. Если не торопиться, то можно ТЗ и полгода писать, но к тому моменту заказчик уже найдёт другого исполнителя, а ТЗ останется всего лишь бумагой для портфолио техписа, а не оплаченным документом.
Пример из последнего опыта:
1 человек, 75 часов чистого времени (2 рабочих недели), по готовому шаблону со стилями - основное ТЗ и 4 ЧТЗ, около 40 приложений, много иллюстраций и схем, которые конвертились из схем визио, суммарное кол-во листов ок. 650
Изменено: Konstantin - 18.10.2013 15:39:33
 
Цитата

... суммарное кол-во листов ок. 650


Это не ТЗ, а нечто совсем другое (предполагаю, что "Эскизный (или технический) проект".
ТЗ - документ на 10 страниц (максимум 30 страниц для очень  функционально насыщенной системы).  
В ТЗ  формулируется ЧТО должно быть сделано, а не КАК.
 
Цитата
Гость пишет:
Цитата

... суммарное кол-во листов ок. 650


Это не ТЗ, а нечто совсем другое (предполагаю, что "Эскизный (или технический) проект".
ТЗ - документ на 10 страниц (максимум 30 страниц для очень функционально насыщенной системы).
В ТЗ формулируется ЧТО должно быть сделано, а не КАК.
Как вы можете предполагать, не видя документа со структурой его разделов? )
Можно писать ТЗ на 10 страниц, а потом писать отдельные документы - технический эскиз, технический проект, функциональные требования на разработку того или иного узла. Зависит от постановки задачи руководителем проекта. Но на практике в реальных проектах кол-во писанины стараются сократить по причинам - см. выше.
В данном случае написано именно ТЗ (и 4 ЧТЗ, 650 листов - это всего по 5 документам), просто оно большое и подробное. И это не противоречит ГОСТ по поводу "КАК", поскольку
ГОСТ 34.602.89
п. 2.1 "5) состав и содержание работ по созданию системы;"
Если следовать методологии, то в данном случае в раздел ТЗ, отвечающий за содержание работ, был включён объём информации, соответствующий техническому проекту вместе с детализацией до спецификаций.
В реальности, заказчику всегда проще работать с одним документом. Я не беру государственные учреждения, а привожу реалии бизнеса.
В общем, техническому писателю задачи ставит руководитель, а не стандарт. Если заказчик хочет один документ - пишется один документ.
и т. д., и т. п.
 
Цитата
Konstantin пишет:
... состав и содержание работ по созданию системы;"


Под "содержанием" работ в ТЗ  понимается перечнь (состав, виды) работ, их последовательность и сроки:  например, обследование объекта, разработка ТЗ, разработка технического (рабочего) проекта,  испытания, опытная эксплуатация, исполнители  и т. п.
А совсем не то,что вы под этим подразумеваете.
 
Цитата
Гость пишет:
ТЗ - документ на 10 страниц (максимум 30 страниц для очень функционально насыщенной системы).
В ТЗ формулируется ЧТО должно быть сделано, а не КАК.
Просто под столом от таких доводов.
На 10 страниц ТЗ на создание шариковой ручки не напишешь, это если  по хорошему.
Ну, а на счет по плохому -  есть такая фраза: "Невнятное ТЗ - результат ХЗ".
 
Цитата
iB пишет:
На 10 страниц ТЗ на создание шариковой ручки не напишешь, это если по хорошему.


Вы правы.
ТЗ на шариковую ручку -1-2 страницы.  
 
Цитата
Гость пишет:
Цитата
Konstantin пишет:
... состав и содержание работ по созданию системы;"


Под "содержанием" работ в ТЗ понимается перечнь (состав, виды) работ, их последовательность и сроки: например, обследование объекта, разработка ТЗ, разработка технического (рабочего) проекта, испытания, опытная эксплуатация, исполнители и т. п.
А совсем не то,что вы под этим подразумеваете.
Я не подразумеваю, то есть не теоретизирую, а описываю свой практический опыт.
Снова смотрим ГОСТ 34.602.89:
"2.7. Раздел «Состав и содержание работ по созданию (развитию) системы» должен содержать перечень стадий и этапов работ по созданию системы в соответствии с ГОСТ 24.601"
Переходим в ГОСТ 24.601
Смотрим:
"2.2. Состав, последовательность и сроки реализации стадий и этапов работ, выполняемых при создании (развитии) АС устанавливают в техническом задании на создание (развитие) системы из числа стадий и этапов, приведенных в таблице."
как вы видите - перчислены не отдельные документы, а этапы создания, поэтому ничто не мешает несколько этапов отразить в одном документе, что на практике зачастую и делается.
Если вы пишете ТЗ из 10 страниц и более ничего, то за вас детализацию все равно потом делает кто-то другой.
Но как вы работаете - ваше личное дело.
 
Цитата

Konstantin пишет:
...как вы видите - перчислены не отдельные документы, а этапы создания, поэтому ничто не мешает несколько этапов отразить в одном документе, что на практике зачастую и делается.


Да, некоторые этапы можно пропускать (типа "обследование объекта автоматизации"). а некоторые объединять (типа "технорабочий проект:).
Но вы занимаетесь подменой понятий:  стадию (этап) работы, которая должна выполняться в определенные сроки,  подменяете уже готовыми приложенными к ТЗ документами,
т.е.формально в вашем ТЗ эти стадии (работы) должны отсутствовать, т. к. они уже кем-то выполнены и брать деньги на их оплату безнравственно.
 
Цитата
Гость пишет:
Цитата

Konstantin пишет:
...как вы видите - перчислены не отдельные документы, а этапы создания, поэтому ничто не мешает несколько этапов отразить в одном документе, что на практике зачастую и делается.


Да, некоторые этапы можно пропускать (типа "обследование объекта автоматизации" ;) . а некоторые объединять (типа "технорабочий проект .
Но вы занимаетесь подменой понятий: стадию (этап) работы, которая должна выполняться в определенные сроки, подменяете уже готовыми приложенными к ТЗ документами,
т.е.формально в вашем ТЗ эти стадии (работы) должны отсутствовать, т. к. они уже кем-то выполнены и брать деньги на их оплату безнравственно.
я не очень понял последнее предложение про безнравственность оплаты. Все эти стадии выполняются, просто они оформлены единым документом. И эти стадии оплачиваются по итогам общего пакета документации.
Заказчику глубоко до фени стандарты и прочее. Он говорит, что напишите мне всё, как и где вы будете делать. И чтобы это был один документ, который будет подписан и по нему потом пойдут все работы. И оплачивает он именно полный подробный документ, то есть формально по ГОСТУ это несколько документов, за каждый из которых можно брать деньги, но оптом всегда дешевле, потому что объём большой и тендер, как правило, выигрывается быстрее. Как-то так.
Но я и не спорю, что в каждом монастыре свой устав. Всё зависит от руководителя проектов в первую очередь и/или продавца услуг, который продаёт их определённый набор (в том числе документацию) за определённую сумму.
Можно делать (и делается), как я описал, можно делать совершенно иначе - всё востребовано.
 
Коллеги, по моему вы ударились в полемику, давно забыв суть вопроса.
А так как задавший вопрос участник форума (TechW) активностей в данной ветке не проявляет, то вопрос скорее всего уже не актуален.
Стоит ли продолжать?
 
Цитата
iB пишет:
Коллеги, по моему вы ударились в полемику, давно забыв суть вопроса.
По сути вопроса - в ТЗ листов регистрации изменений нет и быть не может!

Просто мы говорим о совершенно разных вещах.
ТЗ - документ  на 5-10 страниц, согласованный и подписанный кучей лиц (например, 10 человек).
Некоторые очень бдительные Заказчики, чтобы не было возможности подменять листы, ставят свои визы на КАЖДОЙ странице ТЗ.
Экземпляры ТЗ могут храниться в разных местах - Генподрядчик, субподрядчик, Военная приемка и др.
В подписанном  и утвержденном ТЗ менять ничего нельзя, поэтому в ТЗ листов регистрации изменений нет и быть не может!!!
При необходимости изменений выпускаются Доп. ТЗ (не путать с ЧТЗ), которые опять же утверждаются этими же лицами.

PS К сведению. Лист регистрации изменений относится к утвержденным (любым ) документам, хранящимся в технических архивах. В нем фиксируются не сами изменения, а номера извещений об изменениях.
Сами изменения в документацию вносят не разработчики документов, а  работники технических ахивов по приложенным извещениям.
Это нормативные требования.
Если в вашем монастыре свой  устав, к чему задавать лишние вопросы?  Надо действовать по своим корпоративным  стандартам.
 
Цитата
Konstantin пишет:
Заказчику глубоко до фени стандарты и прочее.
Тогда вообще не понятна цель обращения на форум.
 
И последняя точка в дискуссию.
Согласно существующим правилам ТЗ должен выдавать(разрабатывть) Заказчик.
 
Цитата
Гость пишет:
И последняя точка в дискуссию.
Согласно существующим правилам ТЗ должен выдавать(разрабатывть) Заказчик.
.. либо он может отдать это на аутсорс, в том числе и Исполнителю, который потом по этому ТЗ будет выполнять работу.
 
Цитата
Гость пишет:
Цитата
Konstantin пишет:
Заказчику глубоко до фени стандарты и прочее.
Тогда вообще не понятна цель обращения на форум.
так не Заказчик же обращался ))
и не я, если что.
 
Цитата

Konstantin пишет:
и не я, если что.
Сядут все.
 
Цитата
Гость пишет:
Цитата

Konstantin пишет:
и не я, если что.
Сядут все.
забыли подписаться "Анонимный доброжелатель"
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить картинки
Отправить Отменить