Виды программной документации
Оформление иллюстраций и приложений
Иллюстрации могут быть расположены как по тексту документа, так и в конце его. Иллюстрации должны быть выполнены в соответствии с требованиями ЕСКД.
Иллюстрации нумеруют арабскими цифрами сквозной нумерацией. Допускается нумеровать иллюстрации в пределах раздела.
Например - Рисунок 1.1
При ссылках на иллюстрации следует писать "... в соответствии с рисунком 1.1".
Иллюстрации могут иметь наименование и пояснительные данные. Слово "Рисунок" и наименование помещают после пояснительных данных и располагают следующим образом:
Рисунок 1 - Детали прибора
На приводимых в документе электрических схемах около каждого элемента указывают его позиционное обозначение, и при, необходимости, номинальное значение величины.
Материал, дополняющий текст документа, допускается помещать в приложениях. Это может быть графический материал, таблицы большого формата, расчет, описания аппаратуры, описания алгоритмов и программ и т.д.
Приложение оформляют, как продолжение данного документа на последующих листах либо выпускают в виде самостоятельного документа.
Приложения могут быть обязательными или информационными.
В тексте на все приложения должны быть ссылки.
Каждое приложение следует начинать с новой странице с указанием наверху слова "ПРИЛОЖЕНИЕ" и его обозначения, а под ним в скобках для обязательного приложения пишут слово "обязательное", а для информационного - "рекомендуемое" или "справочное".
|
|
|
Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы отдельной строкой.
Приложение обозначают заглавными буками русского алфавита, начиная с А, исключением являются: Ё, З, Й, О, Ч, Ь, Ы, Ъ. Допускается обозначение приложений буквами латинского алфавита, за исключением букв: I и O.
В случае полного использования букв русского и латинского алфавита допускается обозначать приложение арабскими цифрами. Если приложение одно, то оно обозначается как "Приложение А".
Приложение, как правило выполняют на листах формата А4. Допускается оформлять на листах формата А3, А2, А1 в соответствии с ГОСТ 2.301.
Текст каждого приложения, при необходимости, может быть разделён на разделы, подразделы, пункты, подпункты, которые нумеруются в пределах каждого приложения. Перед номером ставится обозначение этого приложения.
Все приложения должны быть перечислены в содержании документа с указанием их номеров и заголовков.
Построение таблиц
Цифровой материал, как правило, оформляют в виде таблиц. Таблицы нумеруют сквозной нумерацией арабскими цифрами. Название таблицы при его наличии должно быть кратким и помещаться над таблицей. При переносе таблицы на другие страницы название помещают только над первой частью.
|
|
|
Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например "Таблица В1".
Допускается нумеровать таблицы в пределах раздела.
На все таблицы документа должны быть ссылки в тексте, при ссылке следует писать слово "таблица" с указанием номера.
Заголовки граф и строк таблицы следует писать с прописной буквы, а подзаголовки граф - со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят.
Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить.
Головка таблицы должна быть отделена линией от остальной части таблицы.
Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф.
|
|
|
Таблицу в зависимости от её размера, помещают под текстом, в котором впервые дана ссылка на неё, или на следующей странице или в приложении к документу.
Допускается помещать таблицу вдоль длинной стороны листа.
Если строки или графы таблицы выходят за формат страницы, её делят на части, помещая одну часть под другой или рядом, при этом в каждой части таблицы повторяют её головку и боковик. При делении таблицы на части допускается её головку или боковик заменять соответственно номером граф и строк. При этом её нумеруют арабскими цифрами.
Слово "Таблица" указывают один раз слева над первой частью, над другими частями пишут слова "Продолжение таблицы" с указанием номера таблицы .
Таблицы с небольшим количеством граф допускается делить на части и помещать одну части рядом с другой на одой странице, отделяя части таблицы двойной линией или линией толщиной 2S.
Графу "Номер по порядку" в таблицу включать не допускается. Нумерация граф арабскими цифрами допускается:
- при делении таблицы на части;
- если в тексте имеются ссылки на них;
- при переносе таблицы на следующую страницу.
Если все показатели, приведенные в графах таблицы, выражены в одной и той же единице физической величины, то ее обозначение необходимо помещать над таблицей справа, а при делении таблицы на части - над каждой ее частью.
|
|
|
Если в большинстве граф таблицы приведены показатели, выраженные в одних и тех же единицах физических величин, но имеются графы, с показателями, выраженными в других единицах, то над таблицей следует писать наименование преобладающего показателя. В остальных графах приводить наименования единиц физических величин.
Текст, повторяющийся в строках одной и той же графы и состоящий из одиночных слов, чередующихся с цифрами заменяют кавычками. Если повторяющийся текст состоит из двух и более слов, при первом повторении его заменяют словами "тоже", а далее кавычками в соответствии с рис. 4.3.7.
Примечание. Текст, состоящий из двух и более слов, заменяется одной парой кавычек.
Не допускается заменять в таблице повторяющиеся цифры, математические знаки, знаки процента и номера, обозначение марок материалов, типов размеров изделий, обозначение нормативных документов.
При отсутствии отдельных данных в таблице следует ставить прочерк (тире).
В интервале, охватывающем числа ряда между крайними числами ряда в таблице допускается ставить тире. Интервалы чисел в тексте записывают со словами "от" и "до".
Пример:
1 ... толщина слоя от 0,5 до 20 мм.
В таблице при необходимости применяют ступенчатые полужирные линии для выделения диапазона, отнесённого к определённому значению, объединение позиций в группы, и указания предпочтительных числовых значений. При этом в тексте должно быть приведено пояснение этих линий.
Цифры в графах таблицы должны проставляться так, чтобы разряды чисел во всей графе были расположены один под другим, если они относятся к одному показателю.
2 Единая система программной документации (ЕСПД)
Виды программной документации
ГОСТ 19.101 устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Программы подразделяют на виды:
Компонент - программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая как самостоятельная или в составе комплекса.
Комплекс - программа, состоящая из 2-х и более комплектов или комплексов, выполняющих взаимосвязанные функции и применяемая самостоятельно или в составе другого комплекса.
К программным документам относятся документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы. Технические условия разрабатывают на стадии "Рабочий проект".
Необходимость составления технического задания на компоненты, не предназначенные для самостоятельного применения и комплексы, входящие в другие комплексы, определяются по согласованию с заказчиком.
Обозначение программ и программных документов ГОСТ 19.103
Настоящий стандарт устанавливает структуру обозначения программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Обозначение программ и документов должно состоять из групп знаков, разделенных точками (после кода страны и кода организации - разработчика), пробелами (после номера редакции документа и кода вида документа), дефисом (после регистрационного номера документа данного вида).
Устанавливается регистрационная система обозначения программ и программных документов.
Структура обозначения программы и ее программного документа - спецификации выполняется в соответствии с рис.
Структура обозначения других программных документов выполняется в соответствии с рис.
Код страны - разработчика и код организации (предприятия) - разработчика присваивают в установленном порядке. Регистрационный номер присваивают в соответствии с Общесоюзным классификатором программ, утверждаемым Госстандартом, в установленном порядке. До утверждения Общесоюзного классификатора программ допускается присваивать регистрационный номер в порядке возрастания с 00001 до 99999, для каждой организации (предприятия) - разработчика. Номер издания программы или номер редакции документа присваивают в порядке возрастания с 01 до 99.
Код документа присваивают в соответствии с требованиями ГОСТ 19.101 .
Номер документа данного вида присваивают в порядке возрастания с 01 до 99.
Номер части одного и того же документа присваивают в порядке возрастания с 1 до 9.
Примечание. Если документ состоит из одной части, то дефис в порядковый номер части не указывают.
Номер редакции спецификации и ведомости эксплуатационных документов на программу должен совпадать с номером издания этой же программы.
Коды вида документа (ГОСТ 19.101).
Код вида документа Вид документа
- Спецификация
05 Ведомость
12 Текст программы
13 Описание программы
20 Ведомость эксплаутационных документов
30 Формуляр
31 Описание применения
32 Руководство системного программиста
33 Руководство программиста
34 Руководство оператора
35 Описание языка
46 Руководство по техническому обслуживанию
51 Программа и методика испытаний
81 Пояснительная записка
90 – 99 Прочие документы
Дата добавления: 2018-04-05; просмотров: 542; Мы поможем в написании вашей работы! |
Мы поможем в написании ваших работ!