государственный стандарт
СОЮЗА ССР
СИСТЕМЫ АВТОМАТИЗИРОВАННОГО ПРОЕКТИРОВАНИЯ
КОМПОНЕНТЫ МЕТОДИЧЕСКОГО ОБЕСПЕЧЕНИЯ
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ
Издание официальное
ГОСУДАРСТВЕННЫЙ КОМИТЕТ СССР ПО СТАНДАРТАМ Москва
ГОСУДАРСТВЕННЫЙ СТАНДАРТ СОЮЗА ССР
СИСТЕМЫ АВТОМАТИЗИРОВАННОГО ПРОЕКТИРОВАНИЯ
КОМПОНЕНТЫ МЕТОДИЧЕСКОГО ОБЕСПЕЧЕНИЯ
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ
Издание официальное
МОСКВА
РАЗРАБОТАН Академией наук БССР
Государственным комитетом СССР по стандартам Министерством тракторного и сельскохозяйственного машиностроения
Министерством высшего и среднего специального образования РСФСР
Государственным комитетом СССР по науке и технике ИСПОЛНИТЕЛИ
В..Ф. Курочкин, канд. техн. наук; О. И. Семенков, канд. техн. наук; В. В. Бойко, канд. физ.-мат. наук; Д. В. Кривомазов; И. С. Митяев; А. Н. Натолкни; Е. С. Кранков, канд. техн. наук; В. Д. Цветков, д-р техн. наук; П. А. Шалаев, канд. техн. наук; | А. Н. Пономарев); В. К. Давыденко; Л. С. Гранат; В. В. Павлов; Г. С. Бабичев, канд. техн. наук; Н. Н. Безуглов, канд. техн. наук; Е. А. Верзунов; В. А. Симонова; И. Б. Семенихин
ВНЕСЕН Академией наук БССР
Академик АН БССР Л. И. Киселевский, главный ученый секретарь
УТВЕРЖДЕН И ВВЕДЕН В ДЕЙСТВИЕ Постановлением Государственного комитета СССР по стандартам от 19.01.83 № 237
© Издательство стандартов, 1983
УДК 65.015.13.011.56:006.354 Группа Т58
ГОСУДАРСТВЕННЫЙ СТАНД APT СОЮЗ А ССР
Системы автоматизированного проектирования
КОМПОНЕНТЫ МЕТОДИЧЕСКОГО ОБЕСПЕЧЕНИЯ.
Требования к содержанию документов
Computer aided design systems. Requirements to contents of documents
ОКСТУ 0014
Постановлением Государственного комитета СССР по стандартам от 19 января 1983 г. № 237 срок введения установлен
Настоящий стандарт распространяется на техническую документацию методического обеспечения систем автоматизированного проектирования (САПР), создаваемых в проектных, конструкторских, технологических, проектно-изыскательских организациях, в конструкторских и технологических подразделениях на предприятиях и объединениях отраслей промышленности и строительства.
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. В состав методического обеспечения (в случае включения компонентов математического и лингвистического обеспечений) входят документы, в которых изложены теория, методы, способы, математические модели, алгоритмы, языки для описания объектов проектирования, терминология, нормативы, стандарты и другие данные, обеспечивающие процессы проектирования в подсистемах САПР и отражающие правила отбора средств автоматизации выполнения проектных операций (процедур), методику (технологию) автоматизированного проектирования, правила эксплуатации комплекса средств автоматизации проектирования.
1.2. Основными документами методического обеспечения САПР являются:
спецификация методического обеспечения;
общее описание САПР;
Стр. 2 ГОСТ 23501.118-83
инструкция по эксплуатации комплекса средств автоматизации проектирования1; описание языка;
описание проектной операции (процедуры); форма машинного документа.
1.3. Описание теории, способов, математических моделей, нормативов выполняют в соответствии с требованиями стандартов САПР, ЕСПД, ЕСКД и отраслевых нормативных документов.
2. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ
2.1. Документ «Спецификация методического обеспечения» содержит состав документов методического обеспечения САПР. Документ выполняют в соответствии с требованиями ГОСТ 19.202—78.
2.2. Документ «Общее описание САПР» содержит назначение САПР, область применения, правила отбора пользователем состава средств автоматизации выполнения проектных операций (процедур) и методику (технологию) автоматизированного проектирования.
Документ должен состоять из разделов: общие положения; описание САПР;
описание подсистемы (подсистем).
2.2.1. В разделе «Общие положения» указывают; полное название системы автоматизированного проектирования; наименование документов, на основании которых создана система, и ссылку на те документы, которые комплексируют данную САПР; назначение САПР.
2.2.2. В разделе «Описание САПР» приводят:
класс, вид или тип объектов, для проектирования которых предназначена система, а также ограничения на ее применение по отношению к данному классу объектов; структуру САПР;
описание взаимосвязи САПР с другими системами (автоматизированными и неавтоматизированными) в организации;
необходимые сведения об общесистемном программном, информационном и техническом обеспечениях САПР, сведения о развитии системы.
2.2.3. В разделе «Описание подсистемы (подсистем)» приводят:
функциональное назначение подсистемы;
состав комплекса средств автоматизации проектирования и дач рактеристики его компонентов;
ГОСТ 23501.118-83 Стр. 3
схему функционирования подсистемы;
правила отбора пользователем состава средств автоматизации выполнения проектных операций (процедур);
состав, порядок выполнения процедур (операций), а также методику их выполнения в процессе функционирования подсистемы (технологию проектирования);
состав показателей подсистемы и требования к ее подготовке для выполнения автоматизированного проектирования (для проектирующей подсистемы);
правила использования комплекса средств подсистемы для обеспечения автоматизированного проектирования (для обслуживающей подсистемы).
Примечания:
1. Описание состава, порядка выполнения проектных процедур (операций), а также методику их выполнения в процессе функционирования подсистемы допускается выносить в самостоятельный документ «Методика (технология) автоматизированного проектирования».
2. Допускается раздел «Описание подсистемы (подсистем)» оформлять самостоятельным документом «Описание подсистемы САПР» (по каждой подсистеме). В этом случае пункт 2.2.3 в документе «Общее описание САПР» не разрабатывают.
2.3. Документ «Инструкция по эксплуатации комплекса средств автоматизации проектирования» содержит правила эксплуатации службой САПР комплекса средств автоматизации проектирования.
Документ должен состоять из разделов: общие положения;
правила эксплуатации комплекса средств автоматизации проектирования;
возможные неисправности и методы их устранения; указания мер безопасности.
2.3.1. В разделе «Общие положения» указывают название системы автоматизированного проектирования (подсистемы), назначение и состав инструкции.
2.3.2. В разделе «Правила эксплуатации комплекса средств автоматизации проектирования» излагают:
перечень технических условий, в которых приведены указания по эксплуатации комплекса средств автоматизации проектирования;
характеристики и правила эксплуатации каналов связи; порядок обслуживания комплекса средств автоматизации проектирования;
порядок приведения комплекса средств автоматизации проектирования в рабочее состояние, содержание осмотра после окончания его работы.
2.3.3. В разделе «Возможные неисправности и методы их устранения» приводят ссылку на документы, в которых содержатся
Стр. 4 ГОСТ 23501.118-83
сведения по компонентам САПР о характерных и наиболее часто встречающихся или возможных неисправностях, их вероятных причинах и методах выявления и устранения этих неисправностей.
2.3.4. В разделе «Указания мер безопасности» перечисляют требования и нормы безопасности при эксплуатации комплекса средств автоматизации проектирования или дают ссылку на соответствующую эксплуатационную документацию, содержащую эти требования и нормы.
2.4. Документ «Описание языка» содержит описание знаковых средств представления информации в САПР.
Документ должен состоять из разделов:
общие сведения;
способ описания языка;
элементы и основные конструкции языка;
выражения;
руководство по применению языка; приложения.
В зависимости от особенностей языка допускается объединять, отдельные разделы или вводить новые.
2.4.1. Состав и содержание разделов «Общие сведения», «Способ описания языка», «Элементы и основные конструкции языка» и «Выражения» должны соответствовать требованиям ГОСТ 19.506—79.
2.4.2. В разделе «Руководство по применению языка» указывают правила применения и пополнения языковых средств.
Примечание. Допускается данный раздел оформлять отдельным документом.
2.4.3. В приложении к описанию языка должны быть приведены примеры формализованного описания конкретных объектов с помощью установленных языковых средств.
2.5. Документ «Описание проектной операции (процедуры)» содержит описание проектных операций и процедур в подсистемах САПР.
Правила выполнения документа приведены в обязательном приложении 1, а пример оформления — в справочном приложении 2.
2.6. Документ «Форма машинного документа» определяет форму документа, получаемого в процессе функционирования системы автоматизированного проектирования, и содержит:
наименование документа; вид носителя информации;
связь (информационная) с другими документами; порядок расположения информации в документе;
ГОСТ 23501.118-83 Стр. 5
правила чтения документа;форму документа и пример заполнения этой формы (при не~ обходимости).
3. ПРАВИЛА ИЗЛОЖЕНИЯ И ОФОРМЛЕНИЯ
Документацию методического обеспечения САПР излагают и оформляют в соответствии с требованиями ГОСТ 19.106-78 и ГОСТ 21.101-79.
ПРИЛОЖЕНИЕ 1 Обязательное
ПРАВИЛА ВЫПОЛНЕНИЯ ДОКУМЕНТА «ОПИСАНИЕ ПРОЕКТНОЙ ОПЕРАЦИИ (ПРОЦЕДУРЫ)»
1. Общие положения
1.1. Документ «Описание проектной операции (процедуры)> является исходным для разработки соответствующих компонентов программного обеспечения.
1.2. При наличии нескольких проектных операций в системе САПР в комплект документации вводят соответствующее число документов «Описание проектной операции (процедуры)». Допускается объединять описания нескольких проектных операций в одном документе с выделением отдельных проектных операций в самостоятельные разделы документа. При этом документ является компонентом методического обеспечения соответствующей подсистемы.
2. Правила оформления
2.1. Оформление документа «Описание проектной операции (процедуры)»— по ГОСТ 19.106-78.
Наименование документа должно содержать название подсистемы САПР, полное наименование выполняемой проектной операции, и, при необходимости, ее условное обозначение. Полное наименование должно отражать функциональное назначение выполняемой проектной операции, например:
ПРОЕКТИРОВАНИЕ ТЕХНОЛОГИЧЕСКИХ ПРОЦЕССОВ
Бесформатный ввод данных стандартной длины (AKBCF);
ПРОЕКТИРОВАНИЕ ШТАМПОВ
Расчет конструктивных параметров пуансонов с круглой посадочной частью (KRPK);
ПРОЕКТИРОВАНИЕ ИЗДЕЛИЯ...
Выбор оптимального варианта изделия...
22. Документ должен содержать аннотацию и следующие разделы:
описание;
метод выполнения;
схема алгоритма;
контрольный (тестовый) пример;
требования к разработке программы.
При необходимости допускается вводить дополнительные разделы.
2.3. В аннотации определяют назначение проектной операции, область и специфику ее применения.
2.4. В разделе «Описание» указывают содержательное и (или) формализованное описание выполнения проектной операции.
В содержательном описании излагают сущность выполнения проектной операции и технические ограничения, обосновывают выбор критериев оптимальности, при необходимости, приводят чертежи, схемы, графики, раскрывающие смысл проектной операции. Указывают обозначения исходных данных и результаты их обработки. Условные обозначения должны отражать символику, принятую в соответствующей проблемной области. При необходимости указывают ссылки на документы, имеющие отношение к выполнению данной проектной операции.
Формализованное описание содержит: математическую формулировку;
описание входных, выходных, нормативно-справочных данных; список обозначений элементов предметной области с указанием их наименований, единиц измерения, диапазона изменения значений;
ограничения, определяющие допустимые варианты реализации операций; критерии оптимальности для операции оптимизации.
2.5. В разделе «Метод выполнения» описывают предлагаемый метод выполнения операции. При необходимости приводят чертежи, схемы, поясняющие и раскрывающие сущность предлагаемого метода.
Если реализуемая проектная операция имеет нетривиальную математическую интерпретацию, то следует дать ей объяснение или указать источники, которые обеспечивают всестороннее понимание метода.
2.6. В разделе «Схема алгоритма» приводят схему алгоритма выполнения проектной операции. Схему алгоритма выполняют с использованием терминов языка пользователя, на уровне обозначения функций или в виде блок-схемы по ГОСТ 19.002-80 и ГОСТ 19.003-80.
2.7. В разделе «Контрольный (тестовый) пример» приводят пример, обеспечивающий проверку программы, реализующей проектную операцию.
2.8. В разделе «Требования к разработке программы» указывают: спектр диагностических сообщений при работе с программой; требования к контролю данных в процессе выполнения проектной операции;
ограничения, связанные с машинной реализацией; другие данные, необходимые для разработки программы.
Допускается указывать разработанный вариант программной реализации зроектной операции в виде текста программы.
ГОСТ 23501.118-83 Стр. 7
ПРИЛОЖЕНИЕ 2 Справочное
Пример оформления документа «Описание проектной операции (процедуры)»2
УТВЕРЖДЕН
АК—АБВ Г.ХХХХХХ.016. Л У
ПРОЕКТИРОВАНИЕ ШТАМПОВ
Расчет конструктивных параметров пуансонов с круглой посадочной частью (KRPK).
Описание проектной операции
АК—АБВГ.ХХХХХХ.016.А2.01—1
9 стр.
1983 г.
1
Допускается разрабатывать отдельные сИнструкцяя» для системы в валом и каждой входящей в нее подсистемы.
2
При разработке настоящего примера использован материал приложеянв « РД 60—245—812