Wiki для разработчиков технической документации

Формуляр

wiki → Формуляр  
Чтобы стать редактором Wiki оставьте заявку в произвольной форме на форуме 



Формуляр (код вида документа: 30)


В документе "Формуляр" содержатся основные характеристики программы, комплектность и сведения об эксплуатации программы.

1. ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78.

Информационную часть (аннотацию и содержание) допускается в документ не включать.

1.2. В основную часть документа должны входить следующие разделы:


  • общие указания;
  • общие сведения;
  • основные характеристики;
  • комплектность;
  • периодический контроль основных характеристик при эксплуатации и хранении;
  • свидетельство о приёмке;
  • свидетельство об упаковке и маркировке;
  • гарантийные обязательства;
  • сведения о рекламациях;
  • сведения о хранении;
  • сведения о закреплении программного изделия при эксплуатации;
  • сведения об изменениях;
  • особые отметки;
  • приложения.

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

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

2. СОДЕРЖАНИЕ РАЗДЕЛОВ

2.1. В разделе «Общие указания» приводят общие указания для обслуживающего персонала по эксплуатации программного изделия, заполнению и ведению его формуляра, например:


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

2.2. В разделе «Общие сведения» указывают наименование программного изделия, его обозначение, наименование предприятия изготовителя, номер программного изделия предприятия и другие общие сведения о программном изделии.

2.3. В разделе «Основные характеристики» приводят необходимые при эксплуатации программного изделия значения основных характеристик (например, функциональных, надёжности и др.).

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

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

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

2.6. В разделе «Свидетельство о приёмке» приводят свидетельство о приёмке программного изделия, подписанное лицами, ответственными за приёмку (форма 3 приложения).

2.7. В разделе «Свидетельство об упаковке и маркировке» помещают сведения об упаковке программного изделия, подписанные лицами, ответственными за упаковку (форма 4 приложения).

2.8. В разделе «Гарантийные обязательства» приводят гарантийные обязательства предприятия-изготовителя.

2.9. В разделе «Сведения о рекламациях» приводят краткое изложение порядка предъявления рекламации и регистрируют все предъявленные рекламации, их содержание и принятые меры (форма 5 приложения).

2.10. В разделе «Сведения о хранении» указывают сроки хранения программного изделия (форма 6 приложения).

2.11. В разделе «Сведения о закреплении программного изделия при эксплуатации» указывают фамилии и должности лиц, за которыми закрепляют программное изделие (форма 7 приложения).

2.12. В разделе «Сведения об изменениях» указывают основание для внесения изменений, содержание изменений с указанием его порядкового номера, а также должность, фамилию и подпись лица, ответственного за проведение изменения (форма 8 приложения).

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

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

Это нравится:0Да/0Нет

Это нравится:0Да/0Нет
writer
Обсудим страницу Wiki Формуляр, у кого какие предложения? Если был опыт, то подскажите на что обратить внимание при разработке Формуляра.
Это нравится:0Да/0Нет
Наталья
Есть опыт разработки формуляра как по 19, так и по 34 ГОСТу.
Сейчас, в основном, формуляры разрабатываются по 34 ГОСТу (мой опыт). Поэтому придерживаюсь структуры с соответствии с требованиями РД 50-34.698-90:


Цитата
2.9. Формуляр

2.9.1. Документ содержит разделы:
1) общие сведения;
2) основные характеристики;
3) комплектность;
4) свидетельство о приемке;
5) гарантийные обязательства;
6) сведения о состоянии АС;
7) сведения о рекламациях.

2.9.2. В разделе "Общие сведения" указывают наименование АС, ее обозначение, присвоенное разработчиком, наименование разработчика, дата сдачи АС в эксплуатацию, общие указания персоналу по эксплуатации АС, требования по ведению формуляра и месте его хранения, в т. ч. перечень технической документации, с которой должен быть ознакомлен персонал.
2.9.3. В разделе "Основные характеристики" указывают:
1) перечень реализуемых функций;
2) количественные и качественные характеристики АС и ее частей;
3) описание принципов функционирования АС, регламент и режимы функционирования;
4) сведения о взаимодействии АС с другими системами.

2.9.4. В разделе "Комплектность" указывают:
1) перечень технических и программных средств, в том числе носителей данных;
2) перечень эксплуатационных документов.

2.9.5. В разделе "Свидетельство о приемке" указывают:
1) даты подписания актов о приемке АС и ее частей в промышленную эксплуатацию;
2) фамилии председателей комиссий, осуществлявших приемку АС.

2.9.6. В разделе "Гарантийные обязательства" указывают:
1) гарантийные обязательства разработчиков АС по системе в целом и частям, имеющим разные гарантийные сроки;
2) перечень технических средств АС, имеющих гарантийные сроки службы меньше гарантийных сроков для системы.

2.9.7. В разделе "Сведения о состоянии АС" указывают:
1) сведения о неисправностях, в том числе дату, время, характер, причину возникновения и лицах, устранивших неисправность;
2) замечания по эксплуатации и аварийным ситуациям, принятые меры;
3) сведения о проведении проверок измерительных устройств и точностных характеристик измерительных каналов (для АСУ ТП);
4) сведения о ремонте технических средств и изменениях в программном обеспечении с указанием основания, даты и содержания изменения;
5) сведения о выполнении регламентных (профилактических работ и их результатах).

2.9.8. В разделе "Сведения о рекламациях" указывают сведения о рекламациях с указанием номера, даты, краткого содержания рекламационного акта, а также сведения об устранении замечаний, указанных в акте.
Это нравится:0Да/0Нет
writer
Наталья, спасибо!
Это нравится:0Да/0Нет
Iskorka
Разрабатывала формуляр по ГОСТ 2.601, 2.610 ЕСКД. Может ли пригодится в этой теме мой опыт? *writing*
Это нравится:0Да/0Нет
writer
Цитата
Iskorka пишет:
Разрабатывала формуляр по ГОСТ 2.601, 2.610 ЕСКД. Может ли пригодится в этой теме мой опыт?
Iskorka, да конечно, можно на этой  странице WIKI описать разные примеры разработки Формуляра по разным ГОСТам
Это нравится:1Да/0Нет
gunslier
Если подходить к вопросу разработки ФО по ГОСТ 2.601 и 2.610, то смысл этого документа в том, что конечный пользователь сам вносит информацию о жизненных циклах Изделия в него. И реально, если брать в заказчики таких ребят, как войсковые части, то там разделы "Движение Изделия при эксплуатации", "Учёт технического обслуживания" заполняются. Поэтому неплохо привести здесь состав документа из ГОСТ 2.610. На мой взгляд, там довольно подробно описано. Тонкости уже у каждого заказчика свои.
Это нравится:0Да/0Нет
writer
Цитата
gunslier пишет:
Если подходить к вопросу разработки ФО по ГОСТ 2.601 и 2.610, то смысл этого документа в том, что конечный пользователь сам вносит информацию о жизненных циклах Изделия в него. И реально, если брать в заказчики таких ребят, как войсковые части, то там разделы "Движение Изделия при эксплуатации", "Учёт технического обслуживания" заполняются. Поэтому неплохо привести здесь состав документа из ГОСТ 2.610. На мой взгляд, там довольно подробно описано. Тонкости уже у каждого заказчика свои.
а вы можете его привести? Я добавлю тогда в wiki
Это нравится:0Да/0Нет
Odnako
Формуляр на АС (по 34-му ГОСТ), как правило, входит в комплект документов проекта, и разрабатывается на заключительном этапе, когда уже готова Пояснительная записка и Спецификации. И это значительно облегчает его создание, потому что:

2.2. Реализуемые функции - можно взять из Пояснительной записки, раздел "Состав функций и комплексов задач (задач), реализуемых системой"
2.3. Характеристики системы и её частей - из Пояснительной записки, раздел "Потребительские характеристики системы"
3.3. Принципы функционирования АС - из Пояснительной записки, раздел "Схема функциональной структуры"
3.4. Общий регламент и режимы функционирования - из Пояснительной записки, раздел "Режимы функционирования"

ну и т.д.

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