Программная и конструкторская документация: разные системы
Программная и конструкторская документация, это два разных вида технической документации со своими стандартами. Конструкторскую документацию (КД) разрабатывают на изделия по ЕСКД, а программную (ПД), на программы и программное обеспечение по ЕСПД. Путать их нельзя: у каждой своя система стандартов, свои виды документов и своя область применения.
Три параллельные системы документации
В отечественной практике действуют три самостоятельных системы, каждая, на свой тип объекта. Их удобно держать в голове вместе, чтобы не путать.
| Система | Стандарты | На что разрабатывают |
|---|---|---|
| ЕСКД | ГОСТ 2.ХХХ | Изделия: машины, оборудование, приборы |
| ЕСТД | ГОСТ 3.ХХХ | Технологические процессы изготовления |
| ЕСПД | ГОСТ 19.ХХХ | Программы и программное обеспечение |
Про соотношение конструкторской и технологической документации есть отдельный материал про технологическую и конструкторскую документацию. Здесь фокус на третьей системе, программной.
Что такое программная документация
Программная документация, это набор документов, которые сопровождают программу на всех этапах: от разработки до эксплуатации. Виды программных документов задаёт ГОСТ 19.101-77 «Виды программ и программных документов». В комплект могут входить техническое задание, спецификация, текст программы, описание программы, программа и методика испытаний, пояснительная записка, а также эксплуатационные документы: руководство оператора, руководство программиста.
Как и конструкторская, программная документация делится по способу выполнения на подлинник, дубликат и копию. Но регулируется она своей системой стандартов, ЕСПД, а не ЕСКД.
Когда нужны оба вида документации
Бывают объекты, которым нужны и конструкторская, и программная документация одновременно. Это программно-аппаратные комплексы: устройство состоит из физической части (плата, корпус, механика) и программной (встроенное или управляющее ПО). На «железо» разрабатывают конструкторскую документацию по ЕСКД, на программу, программную по ЕСПД.
Смешивать их в одном комплекте по одним правилам нельзя: чертёж платы оформляют по ЕСКД, а описание алгоритма и текст программы, по ЕСПД. Каждый документ живёт по стандартам своей системы, даже если относится к одному изделию.
Иллюстрация: ПО пытались оформить по ЕСКД
Представим ситуацию. Разработчик управляющего контроллера подготовил комплект на устройство и решил описать встроенную программу теми же чертёжными правилами, что и плату, по ЕСКД. На приёмке выяснилось, что программную часть ждут в виде документов ЕСПД: описания программы, руководства оператора, программы и методики испытаний.
Программную документацию пришлось переоформлять по своей системе. Если бы с самого начала разделили: «железо» по ЕСКД, программу по ЕСПД, двойной работы не потребовалось бы.
Частые вопросы
Программная документация, это часть конструкторской?
Нет. Программная документация, самостоятельная система (ЕСПД, ГОСТ 19.ХХХ), параллельная конструкторской (ЕСКД, ГОСТ 2.ХХХ). Одна описывает изделия, другая, программы.
По какому стандарту разрабатывают программную документацию?
По стандартам ЕСПД. Виды программных документов задаёт ГОСТ 19.101-77, а оформление и содержание, другие стандарты этой же системы.
Можно ли оформить программу по правилам ЕСКД?
Нет. Для программ действует своя система ЕСПД. Оформленная по ЕСКД программная документация не будет соответствовать требованиям и её могут не принять.
Что делать, если изделие содержит и электронику, и программу?
На физическую часть разрабатывают конструкторскую документацию по ЕСКД, на программную, программную по ЕСПД. Оба комплекта относятся к одному изделию, но оформляются по разным системам.
Чем ЕСПД отличается от ЕСТД?
ЕСПД, система документации на программы, ЕСТД, на технологические процессы изготовления. Это разные системы: одна про программное обеспечение, другая про то, как изготавливают изделие.
Вывод
Программная и конструкторская документация относятся к разным системам: КД делают на изделия по ЕСКД, программную, на программы по ЕСПД (ГОСТ 19). Вместе с технологической документацией (ЕСТД) это три параллельных комплекса стандартов, и каждый документ оформляют по правилам своей системы, даже если объект один.
Если нужна разработка конструкторской документации на изделие, посмотрите услугу разработка конструкторской документации.