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

Череповец

Указания к выполнению курсового проекта (работы): Учеб.-метод. пособие. Череповец: ЧГУ, 2004. ___ с.

Рассмотрено на заседании кафедры программного обеспечения ЭВМ 11 апреля 2003 г., протокол № 8.

Одобрено редакционно-издательской комиссией Института математики, физики и информатики ЧГУ __________ г., протокол № __.

Рецензенты: А.Н. Зуев – канд. техн. наук, доцент (ЧГУ); Е.В. Коро­лева – канд. техн. наук, инженер (ЦНСА ОАО «Северсталь»)

Составители: Е.В. Ершов – канд. техн. наук, доцент;

Л.Н. Виноградова – ст. преподаватель.

© Череповецкий государственный

университет, 2004

ВВЕДЕНИЕ

Данное учебно-методическое пособие содержит описание и порядок выполнения курсового проекта (работы) по дисциплинам кафедры ПО ЭВМ и предназначено для формирования у студентов навыков разработки программного обеспечения (ПО) и оформления курсового проекта (работы).

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

Составление программной документации - очень важный процесс. На каждое ПО разрабатывается документация двух типов: для пользовате­лей различных групп и для разработчиков.

Раздел 1

Техническое задание

Техническое задание - документ, в котором сформулированы основные цели разработки, требования к ПО, сроки и этапы разработки, а также регламентирован процесс приемно-сдаточных испытаний.

Согласно ГОСТ 19.201-78 «Техническое задание. Требования к содержанию и оформлению» техническое задание содержит следующие разделы:

· титульный лист (см. Приложение 1);

· введение;

· основания для разработки;

· назначение разработки;

· требования к программе;

· требования к программной документации;

· технико-экономические показатели;

· стадии и этапы разработки;

· порядок контроля и приемки.

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

В разделе Основания для разработки содержится наименование документа, на основании которого ведется разработка, организации, утвердившей данный документ, дата его утверждения, а также наименование темы разработки.

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

В разделе Требования к программе содержатся следующие подразделы:

- требования к функциональным характеристикам (перечисляются выполняемые функции, описываются состав, характеристики и формы представления исходных данных и результатов, а также указываются критерии эффективности: максимально допустимое время ответа системы, максимальный объем используемой оперативной и внешней памяти и др);

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

- условия эксплуатации (температура окружающей среды, относительная влажность воздуха для выбранных типов носителей данных, вид обслуживания, необходимое количество и квалификация персонала);

- требования к составу и параметрам технических средств (тип микропроцессора, объем памяти, наличие внешних устройств и т.п.);

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

- требования к маркировке и упаковке (указываются требования к маркировке ПО, варианты и способы упаковки);

- требования к транспортированию и хранению (условия транспортирования ПО, место хранения, условия и сроки хранения, условия складирования);

- специальные требования.

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

Раздел Технико-экономические показатели содержит ориентировочную экономическую эффективность, предполагаемую годовую потребность и экономические преимущества разработки по сравнению с существующими отечественными и зарубежными аналогами.

Раздел Стадии и этапы разработки содержит стадии разработки, этапы и содержание работ, а также сроки разработки и исполнители.

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

В случае, если какие-либо требования, предусмотренные техническим заданием, к ПО не предъявляются, в соответствующем месте необходимо указать «Требования не предъявляются».

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

Раздел 2

расчетно-пояснительнАЯ запискА

Для оформления пояснительной записки необходимо внимательно изучить ГОСТ 7.32-91 (ИСО 5966-82) «Отчет по научно-исследовательской работе. Структура и правила оформления». В соответствии с этим стандартом пояснительная записка включает в себя:

· титульный лист (см. Приложение 2);

· аннотацию;

· оглавление;

· введение;

· основную часть;

· заключение;

· список литературы;

· приложения.

Титульный лист оформляют в соответствии с ГОСТ 19.104—78 «Единая система программной документации. Основные надписи».

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

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

На четвертой странице и далее следуют введение и основная часть.

Основная часть содержит следующие разделы:

· общие сведения;

· функциональное назначение;

· описание логической структуры;

· используемые технические средства;

· вызов и загрузка;

· входные данные;

· выходные данные.

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

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

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

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

В разделе «Используемые технические средства» указываются типы электронно-вычислительных машин и устройств, которые используются при работе программы.

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

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

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

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

После заключения, в котором в краткой форме излагаются выводы о проделанной работе, результатах исследования в данной проблемной области, следуют список литературы и приложения, где содержится материал, не вошедший в пояснительную записку, но представляющий определенный интерес для более глубокого понимания материала (например, техническое задание - ГОСТ 19.201-78, схемы алгоритмов и программ – ГОСТ 19.002-80, программа и методика испытаний - ГОСТ 19.301-79, текст программы – ГОСТ 19.401-78, руководство пользователя).

В приложении 3 приведен пример оглавления расчетно-пояснительной записки к курсовому проекту по дисциплине «Технология разработки программного обеспечения».

Раздел 3

Руководство пользователя

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

Руководство пользователя содержит следующие разделы:

· общие сведения о программе;

· описание установки;

· описание запуска;

· инструкции по работе (или описание пользовательского интерфейса);

· сообщения пользователю.

В разделе Общие сведения о программе содержится наименование программы, краткое описание ее функций, реализованных ме­тодов и областей применения.

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

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

В раздел Инструкции по работе содержится описание режимов ра­боты, возможных настроек, форматов ввода-вывода информации.

В разделе Сообщения пользователю содержится перечень возмож­ных сообщений, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.

В зависимости от вида ПО может возникнуть необходимость создания отдельного руководства системного программиста и (или) оператора.

Согласно ГОСТ 19.503-79 «Руководство системного программиста. Требования к содержанию и оформлению» руководство системного программиста со­держит всю информацию, необходимую для установки программного обес­печения, его настройки и проверки работоспособности. ­

Руководство системного программиста содержит следующие разделы:

· общие сведения о ПО,

· структура;

· настройка;

· проверка;

· дополнительные возможности;

· сообщения системному программисту.

Согласно ГОСТ 19.505-79 «Руководство оператора. Требования к содержанию и оформлению» руководство оператора содержит следующие разделы:

· назначение программы;

· условия выполнения программы;

· выполнение программы;

· сообщения оператору.

Раздел 4

Основные правила оформления

программной документации

При оформлении текстовых и графических материалов, входящих в курсовой проект (работу) следует придерживаться действующих стандартов (ГОСТ 19.ХХХ).

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

Текстовые доку­менты оформляются на белых листах формата А4, графический материал до­пускается представлять на листах формата A3. В соответствии с общими требованиями поля листа определяются следующим образом: левое — 30, правое - 10, верхнее – не менее 15, а нижнее - не менее 20 мм.

Нумерация всех страниц (в том числе и приложений) - сквозная. Номер проставляется либо сверху спра­ва, либо снизу справа арабской цифрой. Первая страница - титульный лист. Номер страницы на титульном листе не проставляется.

Наименование разделов пишется прописными буквами посередине строки. Расстояние между заголовками и текстом, а также между заголовками разделов и подразделов должно быть равно:

· при выполнении документа машинописным способом — двум интервалам;

· при выполнении рукописным способом — 10 мм.

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

· при выполнении документа машинописным способом - трем интерва­лам;

· при выполнении рукописным способом — не менее 15 мм.

Разделы и подразделы нумеруются арабскими цифрами с точкой. Разде­лы имеют порядковые номера 1, 2, и т. д. Номер подраздела состоит из номера раздела и порядкового номера подраздела, входящего в данный раздел, разделенных точкой. Например: 1.1, 2.5. При использовании ссылок на пункты, разделы и подразделы указывается порядковый номер раздела или пункта, на­пример: «в разд. 2», «в п. 2.3».

Текст разделов печатается через 1,5 интервала при высоте букв не менее 2 мм (шриф­ты № 12-13).

При работе в текстовом редакторе перечисления нумеруются арабскими цифрами со скобкой (на­пример: 2), 3) и т. д.) с абзацного отступа, используя для этого нумерованные списки. Допускается также применение маркированных списков.