Общие требования по выполнению документации

Состав документации

ВЫПОЛНЕНИЕ ДОКУМЕНТАЦИИ

Разрабатываемый в дипломном проекте продукт должен сопровождаться соответствующей документацией.

В соответствии с ЕСПД (ГОСТ 19.101) все программные документы (ПД) можно разделить на проектные и эксплуатационные. При дипломном проектировании обычно круг ПД ограничен видами, приведенными в таблицах 3.1 и 3.2.

В число обязательных документов комплекта КД, разрабатываемых в соответствии с уровнем дипломного проекта, кроме пояснительной записки входят схемы алгоритмов, программ, данных, ресурсов системы, взаимодействия программ (ГОСТ 19.701).

Таблица 3.1 – Номенклатура проектных программных документов

Документ	Код документа
1. Пояснительная записка 2. Спецификация 3. Текст программы 4. Описание программы	-

Таблица 3.2 – Номенклатура эксплуатационных программных документов

Эксплуатационный документ	Код документа
1. Описание применения 2. Руководство системного программиста 3. Руководство программиста 4. Руководство оператора

В случае ДПП в число обязательных ПД кроме пояснительной записки входит текст программы (или ее основной части) объемом примерно 15–20 с., описание программы и один из эксплуатационных документов. В случае большого по объему программирования следует составлять спецификацию. Графический материал оформляется при составлении программных документов как рисунки и не имеет специальных шифров или кодов.

Все документы выполняются на листах стандартного формата (ГОСТ 2.301); чертежи и схемы (кроме схем алгоритмов) должны иметь рамку и основную надпись (штамп), выполняемые в соответствии с ГОСТ 2.104. Пример выполнения основной надписи показан на рисунке. 3.1.

Рисунок 3.1 – Основные надписи

Основные надписи располагают в правом нижнем углу конструкторских документов. На листах формата А4 основные надписи располагаются вдоль короткой стороны листа.

Основную надпись на чертежах и схемах выполняют по форме 1 (рисунок 3.1, а) на первом и заглавном листах, на последующих листах – по форме 2а (рисунок 3.1, б). Дополнительные графы основной надписи допускается не выполнять.

В графах основной надписи (номера граф на рисунке 3.1 заключены в скобки) указывают:

в графе 1 — наименование изделия (детали, сборочной единицы и т. д.) и ниже с новой строки наименование документа (кроме спецификации и чертежа детали). Все наименования приводят в именительном падеже единственного числа, начиная с имени существительного, написанного с прописной буквы;

в графе 2 — обозначение документа по ГОСТ 2.201. Первый элемент обозначения - код организации-разработчика КД. Учебные университеты кода не имеют, и занятую им позицию следует заполнять аббревиатурой ЛЭТИ. Второй элемент обозначения – цифровой код классификационной характеристики изделия, устанавливаемый классификатором ЕСКД; эту позицию следует заполнять шестью крестами. В ДП, как правило, изменяется предпоследний элемент – трехразрядный номер КД, присваиваемый бюро стандартизации предприятия (в учебных КД – порядковый номер в ДП), и последний элемент – код вида документа по ГОСТ 2.102;

в графе 3 — обозначение материала детали; в разработках, выполненных автоматизированным способом (например, в системе PCAD), целесообразно указывать спецификацию соответствующего файла;

в графе 4 — литера документа – литера, присвоенная документации в соответствии с условленной в ТЗ стадией разработки: "П" – техническое предложение, "Э" – эскизный проект, "Т" – технический проект, "О" – опытный образец, "А" – серийный образец;

графы 5 и 6 – масса и масштаб – заполняются, только когда имеют смысл;

в графе 7 – порядковый номер листа (документа на нескольких листах);

в графе 8 – общее количество листов документа (графу можно заполнять только на первом листе);

в графе 9 – сокращенное наименование организации; поскольку ЛЭТИ записывается в графе 2, то в ДП здесь целесообразно указывать номер группы.

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

Текстовые документы выполняются чернилами, тушью или пастой (все одинаково) черного или синего цвета. Чертежи и схемы – можно карандашом. Топологические чертежи фрагментов БИС целесообразно выполнять цветными. При выполнении плакатов можно использовать цветную тушь (фломастер).

Во всех документах должны быть использованы стандартные обозначения основных физических величин (ГОСТ 1494) и единиц их измерения (ГОСТ 8.417). Нестандартные, введенные автором обозначения, должны быть расшифрованы.

Дата добавления: 2015-05-07