Правила оформления программных документов

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

4.6.4. 2. Программные документы должны включать:

- текст программы, оформленной согласно ГОСТ 19.401-78;

- описание программы, выполненное по ГОСТ 19.402-78;

- описание применения согласно ГОСТ 19.502-78.

. Программный документ «Текст программы» содержит аннотацию и собственно текст программы. В текст программы необходимо включать комментарии, отображающие функциональное назначение программного средства, его структуру и т.п.

Программный документ «Описание программы» состоит из аннотации и основной части. Последняя должна содержать следующие разделы.

Общие сведения – полное наименование программного средства; программное обеспечение, необходимое для его функционирования; языки программирования, на которых написано программное средство.

Функциональное назначение – классы решаемых задач и (или) назначение программного средства и сведения о функциональных ограничениях на применение.

Описание логической структуры – алгоритм программного средства;

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

Используемые технические средства – типы ЭВМ и устройств, которые используются при работе программного средства.

Вызов и загрузка – способ вызова программного средства с соответствующего носителя данных; входные точки в программное средство.

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

Входные данные – характер, организация и предварительная подготовка входных данных; формат, описание и способ кодирования входных данных.

Выходные данные – характер и организация выходных данных; формат, описание и способ кодирования выходных данных.

В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.

Программный документ «Описание применения» состоит из аннотации и основной части.

Основная часть должна содержать следующие разделы: назначение программы – назначение программного средства, его возможности; основные характеристики; ограничения, накладываемые на область применения.

Условия применения – условия, необходимые для выполнения программного средства (требования к необходимым для данного программного средства техническим средствам, а также требования к другим входящим в него программам, операционным системам и системам программирования; общие характеристики входной и выходной информации; требования и условия организационного и технологического характера и т.п.

Описание задачи – определение (формулирование) задачи и методы ее решения.

Входные и выходные данные – сведения о входных и выходных данных.

В зависимости от особенностей программного средства допускается вводить дополнительные разделы или объединять отдельные разделы. Например, можно ввести следующие разделы:

Введение – состояние вопроса; литературные источники со ссылками; актуальность решаемой задачи; сравнение с аналогичными программными разработками и т.п.

Общие сведения – обозначение и полное наименование программного средства; используемая (тип) ЭВМ; язык программирования; сведения об используемой операционной системе и системе программирования; носители данных и т.п.

В приложении к описанию применения могут быть включены справочные материалы (иллюстрации, таблицы, графики, примеры и т.п.).

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

4.6.6. Оформление списка литературы по ГОСТу

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

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

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

4.6.5.1 Список использованной литературы составляется в строго приоритетном порядке, начиная с нормативных правовых актов федерального уровня, индивидуальных и коллективных монографий, научных статей и т.д.

Пример иерархии источников списка литературы:

1. Нормативно-правовые акты;

2. Материалы практики;

3. Литература и периодические издания;

4. Литература на иностранных языках;

5. Интернет источники.

Если в работе не использовался какой-либо вид источников, то его можно пропустить. Основными элементами описания литературного источника являются:

ФИО автора (авторов / редактора);

Наименование произведения (название книги);

Наименование издательства;

Год издания;

Количество страниц в издании.

4.6.5.2 Оформление книг с 1 автором Для книг написанных одним автором в начале указываются фамилия и инициалы автора. При этом после фамилии ставится запятая и уже после неё указываются инициалы отделённые точками. Затем следует полное название книги, после которого ставится «слеш» (косая черта “ / “) и далее повторяется ФИО автора, но сначала указываются инициалы, а затем фамилия. После фамилии ставится точка, а за ней – тире. После тире указывается: город, двоеточие, название издательства, запятая, год издания, точка. После точки пишем тире, за ним указываем количество страниц в данной книге, букву «с» и точка.

Схематичный пример:

Иванов, И.И. Название книги / И.И. Иванов. – Город: Название издательства. – 552 с.

Реальный пример:

Жабина С.Г. Основы экономики, менеджмента и маркетинга в общественном питании / С.Г. Жабина. - М.: Академия, 2014. - 336 с.

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

Название города Обозначение в списке литературы Комментарий

Москва М.

Санкт-Петербург СПб.

Ростов-на-Дону Ростов н/Д.

Нижний Новгород Н.Новгород.

Ленинград Л. Для литературы выпущенной в СССР.

Обратите внимание, после сокращённого наименования сразу ставится точка. После неё без пробела сразу пишется двоеточие и указывается название издательства. М.:_______ Спб.:_____ и т.д. Для остальных городов в списке литературы указываются их полные наименования, после чего сразу идёт двоеточие (а не точка, как в случая с сокращёнными наименованиями).

4.6.5.3 Оформление книг с 2 и 3 авторами

Если книга написана авторским коллективом из 2-3 человек, то в начале библиографического описания указываются фамилия и инициалы одного (первого) автора. После фамилии ставится точка. Далее следует полное название книги. Затем ставится «слеш» и идёт повторение данных авторов, но сначала указываются инициалы, а потом фамилия. После последней фамилии ставится точка, а за ней – тире. После тире указывается: город, двоеточие, название издательства, запятая, год издания, точка. После точки пишем тире, за ним указываем количество страниц в данной книге, букву «с» и точка.

Пример:

Волков М.В. Современная экономика/ М.В. Волков, А.В. Сидоров. - СПб.: Питер, 2014.- 155 с.

4.6.5.4 Оформление книг с 4 и более авторами Для книг, у которых 4 и более авторов действует особый порядок оформления. В целом он аналогичен тому, что применяется в книгах с 2 и 3 авторами, но с одним исключением: При повтором перечислении авторов после наименования книги и «слеша» указываются не все авторы, а опять лишь первый. При этом его ФИО дополняется заключённой в квадратные скобки припиской [и д.р.]

Пример: Коробкин, М.В. Современная экономика/ М.В. Коробкин [и д.р.] -СПб.: Питер, 2014.- 325 с. Оформление учебников и учебных пособий

Если в списке литературы указываются учебные пособия, учебники, учебно-методические комплексы и прочие виды специальной литературы, необходимо дополнить общие правила оформления элементом обозначения типа издания. Для этого в указанные выше правила оформления книг, сразу после наименования издания ставится двоеточие и пишется тип издания.

Пример: Волков, М.В. Современная экономика: учебное пособие / М.В. Волков. - СПб.: Питер, 2014.- 225 с.

или если используется общее обозначение материала

Волков, М.В. Современная экономика [Текст]: учебное пособие / М.В. Волков. - СПб.: Питер, 2014.- 225 с.

4.6.5.5 Оформление учебников и учебных пособий под редакцией

Для оформления учебного пособия под редакцией одного автора, объединившего труды нескольких авторов, нужно сначала написать наименование издания, далее двоеточие и тип издания (учебник / учеб. пособие), далее «слеш» и фраза «под ред.». После этого указываются сначала инициалы, а затем фамилия редактора. Дальше следует стандартный порядок оформления, приведённый выше. гост список литература

Пример:

Фармацевтическая химия: учеб. пособие для студ. вузов/под ред. И.Н. Совенко. -М.: Риор, 2014. - 323 с.

Если в пособии несколько авторов с общим редактором.

Пример:

Фармацевтическая химия: учеб. пособие для студ. вузов / Л.Н. Протасова., М.И. Иванов, А.А. Сидоров; подред. И.Н. Совенко.. - М.: Риор, 2014. -323 с.

4.6.5.6 Оформление в списке литературы статей из журналов и периодических сборников Для описания статей из периодических изданий действует следующий порядок указания элементов описания библиографического источника: фамилия и инициалы автора; название статьи; «слеш» и снова ФИО автора, но сначала инициалы, а потом фамилия; затем две косые черты; название периодическог оиздания или сборника, в котором размещена статья (кавычки не используются); тире, год издания; после чего следуют точка, номер (иногда в скобках может быть указан месяц издания); точка, тире; затем номера первой и последней страниц статьи.

Пример:

Боков, В.К. Причины кризиса экономической модели США / В.К. Боков // РБК. -2014. - №4 (11). - С. 32-36.