ли она есть), год выпуска, том (если есть), номер издания (журнала) и номера страниц, на которых помещена статья.
При ссылке на источник из списка литературы (особенно при обзоре аналогов) надо указывать порядковый номер по списку литературы, заключенный в квадратные скобки; например: [5].
11.6. Правила оформления расчетно–пояснительных записок при курсовом проектировании
При оформлении пояснительных записок следует придерживаться ГОСТ 7.32–91 (ИСО 5966–82) «Отчет по научно-исследовательской работе. Структура и правила оформления». В соответствии с этим стандартом текстовый документ подобного типа должен включать:
•титульный лист,
•реферат,
•содержание,
•введение,
•основную часть,
•заключение,
•список использованных источников, в том числе литературы,
•приложения.
Титульный лист оформляют в соответствии с ГОСТ 19.104–78 «Единая система программной документации. Основные надписи» (рис. 11.1).
Вторая страница – реферат или аннотация на разрабатываемый программный продукт. Реферат в сжатом виде должен содержать сведения об объеме документа, количестве иллюстраций, таблиц приложений и т. п., а также перечень ключевых слов и основные положения документа. Например, для отчета по научно–исследовательской работе: описание объекта исследования, цели работы, методы исследования и аппаратура, полученные результаты, рекомендации по внедрению и т. д. В аннотации также в сжатом виде описывают назначение и особенности разработки, но она обычно не включает сведений об объеме и т. п.
Третья страница – содержание, включающее: введение, наименование всех разделов, подразделов, пунктов, заключение, списки литературы и приложений с указанием номеров страниц. Ни аннотация или реферат, ни само содержание в оглавлении не упоминают.
Затем следуют разделы документа в порядке, определенном логикой изложения материала. Далее могут следовать приложения, содержащие материал, не вошедший в документ по причине его ограниченного объема, но интересный для более глубокого понимания излагаемого материала.
308
Министерство образования Российской Федерации Московский государственный технический университет имени Н.Э. Баумана
Факультет Информатика и системы управления Кафедра Компьютерные системы и сети
СИСТЕМА УЧЕТА ТЕКУЩЕЙ УСПЕВАЕМОСТИ СТУДЕНТОВ
Расчетно-пояснительная записка к курсовой работе
Листов 25
Руководитель, |
|
|
|
канд. техн. наук, доцент |
|
|
Петров П.П. |
|
|
|
|
|
|
|
|
Исполнитель, |
|
|
|
студент гр. ИУ6-31 |
|
|
Иванов И.И. |
|
|
|
|
2002
Рис. 11.1. Пример титульного листа расчетно-пояснительной записки
309
В качестве примера рассмотрим оглавление пояснительной записки к проекту по курсу «Технология программирования».
|
Содержание |
|
Введение |
4 |
|
1. |
Выбор технологии, языка и среды программирования |
6 |
2. |
Анализ и уточнение требований к программному продукту |
7 |
|
2.1. Анализ процесса обработки информации и выбор структур |
|
|
данных для ее хранения |
7 |
|
2.2. Выбор методов и разработка основных алгоритмов решения задачи |
9 |
3. |
Разработка структурной схемы программного продукта |
11 |
4. |
Проектирование интерфейса пользователя |
13 |
|
4.1. Построение графа диалога |
13 |
|
4.2. Разработка форм ввода-вывода информации |
14 |
5. |
Проектирование классов предметной области |
17 |
|
5.1. Построение диаграммы классов |
17 |
|
5.2. Уточнение структуры классов предметной области |
|
|
и разработка алгоритмов методов |
19 |
6. |
Выбор стратегии тестирования и разработка тестов |
21 |
Заключение |
24 |
|
Список литературы |
25 |
|
Приложение 1. Техническое задание |
26 |
|
Приложение 2. Руководство пользователя |
30 |
|
Контрольные вопросы
1.Назовите основные виды программной документации. Охарактеризуйте каждый из них. В каких случаях их используют?
2.Что должно описываться в пояснительной записке? Кому она предназначена? Почему в пояснительной записке обычно описывают не только принятые решения, но и отвергнутые варианты?
3.На кого рассчитано руководство пользователя? Что оно должно содержать? В каких ситуациях вы читаете руководство пользователя? Вспомните прочитанные вами руководства пользователя. Что вам в них не понравилось?
310
ПРИЛОЖЕНИЕ
Система условных обозначений унифицированного языка моделирования (UML)
Унифицированный язык моделирования UML – фактически стандартное средство описания проектов, создаваемых с использованием объектно–ориентированного подхода. В модель проекта программного обеспечения по замыслу авторов языка может входить большое количество диаграмм различных типов, использующих единую систему обозначений. Среди диаграмм наиболее часто используемыми являются:
•диаграммы вариантов использования или прецедентов (uses case diagrams) –
показывают основные функции системы для каждого типа пользователей;
•диаграммы классов (class diagrams): контекстные, описания интерфейсов и реализации – демонстрируют отношения классов между собой;
•диаграммы деятельностей (activity diagrams) — представляют собой схему потоков управления для решения некоторой задачи по отдельным действиям, допускают наличие параллельных и/или альтернативных действий;
•диаграммы взаимодействия (interaction diagrams) двух альтернативных типов:
а) диаграммы последовательности действий (sequence diagrams) – отображают упорядоченное по времени взаимодействие объектов в процессе выполнения варианта использования,
б) диаграммы кооперации (collaboration diagrams) – предоставляют ту же информацию, что и диаграммы последовательности действий, но в форме, позволяющей лучше представить ответственности классов в целом;
•диаграммы состояний объекта (statechart diagrams) – показывают со стояния объекта
иусловия переходов из одного состояния в другое;
•диаграммы пакетов (package diagrams) – демонстрируют связи наборов классов, объединенных в пакеты, между собой;
•диаграммы компонентов (component diagrams) – показывают, из каких программных компонентов состоит программное обеспечение и как эти компоненты связаны между собой;
311
• диаграммы размещения (deployment diagrams) – позволяют связать программные и аппаратные компоненты системы.
Дополнениями к диаграммам служат формализованные и неформализованные текстовые описания, комментарии и словари.
При построении этих и других диаграмм используют унифицированную систему обозначений. Обозначения диаграмм прецедентов приведены в табл. П.1, диаграмм классов и пакетов – в табл. П.2, диаграмм взаимодействия – в табл. П.З, диаграмм деятельностей и состояний объекта – в табл. П.4, диаграмм компонентов и размещения – в табл. П.5. При необходимости допускается использование обозначений одних диаграмм на других.
312
313
314