ИТМ_1 курс_заочникам / Описание проектных решений (правила оформления реферата)
.pdfданных, структуру автоматизированной системы и др. Как правило, структурная схема изображается в виде прямоугольников и других фигур, содержащих внутри себя текст и связанных друг с другом линиям или стрелками. В зависимости от композиции допускается любое выравнивание надписей. При изображении структурной схемы необходимо минимизировать число пересечений линий, упорядочить размещение элементов схемы, унифицировать размеры элементов и стили линий, а также добиться максимально простой и понятной формы. Изображая структурнуюсхемуалгоритма, необходимопользоватьсястандартными символами, приведенными в таблице 8.
Структурные схемы можно создавать с помощью редактора, в котором готовится отчет (например, MS Word), а также с помощью специализированных средств – универсальных пакетов для структурного моделирования (например, Visio), пакетов для изображения организационных процессов (BPWin и другие CASE-средства), средств для построения концептуальных схем данных (таких как ERWin, Power Designer и др.), векторных графических редакторов общего назначения (Corel Draw), систем автоматизированного проектирования (AutoCAD) и др.
3.1.3 Оформление таблиц
Таблицыприменяютдляудобствасравненияразличныхпоказателей. Верхнюю часть таблицы называют головкой, левую графу – боковиком. Обычно в боковике перечисляются обозначения тех объектов, которые характеризуются в данной таблице, а в головке – показатели (свойства), которыми характеризуются эти объекты.
Все таблицы отчета следует располагать непосредственно после текста, в котором они упоминаются впервые, или на следующей странице. Над таблицей слева без абзацного отступа помещается ее заголовок, включающий в себя слово «Таблица», порядковый номер таблицы, после которого следует тире и названиетаблицыстрочнымибуквамиспервойпрописнойбезточки в конце. Нумерация таблиц осуществляется аналогично нумерации иллюстраций. На каждую таблицу в тексте отчета должна быть ссылка, записываемая следующим образом: «... приведены в таблице 8». При заимствовании таблицы из другого ли-
51
тературногоисточникавзаголовкедолжнаприсутствоватьссылка на этот источник.
Если таблица не помещается на одну страницу, ее можно разбить на несколько частей. При переносе части таблицы на другую страницу заголовок указывают только над первой частью таблицы, над остальными частями пишут, например «Продолжениетаблицы8». Еслизаформатстраницывыходятеестроки, товкаждойчаститаблицыдублируетсяголовка, еслинастраницу не помещаются графы, то повторяется боковик.
Внутреннюю структуру таблицы показывают с помощью разграничительных линий. Обязательными являются горизонтальные линии сверху и снизу таблицы и горизонтальная линия, отделяющая головку от содержимого таблицы. Нижняя горизонтальная линия не проводится, если таблица имеет продолжение на следующей странице. Остальные линии вычерчиваются только в том случае, если они повышают удобство пользования таблицей (рисунок 12).
Все надписи внутри таблицы должны начинаться с прописной буквы преимущественно с выравниванием влево. Заголовки граф в головке таблицы пишутся в единственном числе. Заголо-
Эти линии |
Все надписи начинаются |
Повторение |
обязательны |
с прописной буквы |
одного слова |
Таблица 9 – Сравнительные характеристики CASE-средств (по [17]) |
||
Пакет |
Основное назначение |
Используемая |
|
|
нотация |
ERWin |
Информационное моделирование |
Баркера |
Designer 2000 |
То же |
‘‘ |
Designer IDEF |
Функциональное моделирования |
IDEF |
BPWin |
То же |
IDEF, DFD |
Easy CASE |
Функциональное моделирование |
IDEF, DFD |
|
Информационное моделирование |
Чена |
Боковик |
Повторение |
Эти линии отделяют не только |
|
нескольких слов |
строки таблицы, но и группы |
Рисунок 12 – Основные правила оформления таблиц
52
вок таблицы и надписи внутри таблицы могут выполняться шрифтом меньшего, чем в тексте отчета, размера (но не меньше 10). Встречаются таблицы, в которых ячейки, расположенные другподдругом, содержатповторяющийсятекст. Еслиэтоттекст состоит из одного слова, то его допускается заменять кавычками. Если повторяющийся текст состоит из нескольких слов, то при первом повторении его заменяют словами «То же», а далее – кавычками. Если ячейка не содержит никакой информации, то в ней ставится прочерк.
3.1.4 Оформление формул
Формулы следует печатать на отдельной строке с абзацно- |
||||||||
го отступа. В конце формулы ставится соответствующий тексту |
||||||||
знак препинания. Формулы, на которые в тексте отчета содер- |
||||||||
жатся ссылки, необходимо нумеровать сквозной нумерацией в |
||||||||
пределах всего отчета и пределах каждого приложения. Номер |
||||||||
формулы записывается арабскими цифрами в круглых скобках |
||||||||
в крайней правой позиции строки. Номер формулы в приложе- |
||||||||
нии должен начинаться с буквы – обозначения приложения, от- |
||||||||
деленной от номера точкой, например, (Б.3). Ссылка на форму- |
||||||||
лу в тексте отчета дается в скобках, например, ... в формуле (1). |
||||||||
Наиболее популярным и простым средством выполнения |
||||||||
формул в отчетах является редактор MS Equation. Все перемен- |
||||||||
ные в формулах, за исключением греческих символов, печатают- |
||||||||
ся курсивом; числа, математические функции, текст – обычным |
||||||||
шрифтом. Размер символов в формуле должен быть таким же, |
||||||||
как и размер шрифта основного текста отчета. Индексы должны |
||||||||
быть ненамного меньше: так, если размер переменных 12 или 14 |
||||||||
пт, то размер индексов следует делать 10 или 12 пт соответствен- |
||||||||
но. Создаваемая редактором формула обычно нуждается в до- |
||||||||
работке. Ниже показана такая «необработанная» формула: |
||||||||
|
|
n |
m |
|
|
|
|
|
s |
j |
= ∑∑ |
|
(λ |
ij |
− λ |
ik |
)2 . |
i=1 k=1
Ее недостатками являются мелкий размер индексов, значительные промежутки между отдельными символами и, наоборот, «прилепленные» друг к другу индексы под λ и под знаками сумм. Чтобы сделать формулу более «читабельной», необходимо вос-
53
пользоваться функциямиподгонкивредакторе, приведяеек сле- |
|
дующему виду: |
|
sj = ∑n ∑ m (λ i j − λ ik )2 , |
(1) |
i =1 k =1 |
|
где λ i j , λ ik – относительные значимости i-го объекта по мнению j-го и k-го экспертов соответственно.
Пояснение значений символов и коэффициентов с указанием их размерности следует начинать со слова «где», печатаемого непосредственноподформулойбезабзацногоотступа(каквформуле (1)). Таким же образом – без абзацного отступа после формулы –пишется любой другой текст, если только он по смыслу не является новым абзацем. Если формула не помещается на одной строке, то ее можно переносить на знаках «=», «+», «–», «:», «× », причем знак в начале следующей строки повторяют.
3.2 Описание программного обеспечения
ДокументированиеПОрегламентируетсясериейГОСТ, называемыхЕдинойсистемойпрограммнойдокументации(ЕСПД) [2] и устанавливающих следующее:
правилавыполнениясхемалгоритмовипрограмм[3] иприменяемые при этом графические символы [4];
термины и определения [5], виды программ и документов [6], стадии разработки ПО [7];
требования к документам, необходимым на стадии разработки и изготовления ПО, например, к техническому заданию [8] и тестированию [9];
требованиякдокументам, необходимымдлясопровождения ПО, таким как текст программы [10] и описание программы [11]; требования к документам, необходимым при эксплуатации ПО, основными из которых являются описание применения [12], руководство системного программиста [13], руководство про-
граммиста [14], руководство оператора [15].
Если составление программной документации является частью задания, поставленного руководителем, то студент в своем отчете должен приводить эти документы, выполненные строго в соответствии с ЕСПД (со своим титульным листом, аннотацией
54
и другими структурными элементами) в виде отдельных приложений. В остальных случаях информация о ПО структурируется по правилам составления соответствующих программных документов и сводится в один раздел отчета, как это сделано, например, в приложении Д. Каждый подраздел этого раздела будет содержать информацию из одного программного документа. Учитывая, что отдельные фрагменты информации в различных документах дублируются, в данномпособии предлагаетсяоблегченная схема описания ПО, избегающая такого дублирования и во многом основанная на требованиях ЕСПД. Рассмотрим ее.
Допускается описание ПО, выполненное в виде двух подразделов отчета – описания программы и описания применения, а также приложения, содержащего текст программы.
Описание программы отражает сведения о назначении и логической структуре ПО. В него входит следующая информация.
1. Общие сведения. Дается наименование и/или обозначение (идентификатор) программы, включая расшифровку аббревиатуры или пояснение ее названия. Указываются данные об авторе, версия программы, год и место разработки, сведения об авторском праве на программу и его регистрации.
2. Функциональное назначение. Описываются классы решае-
мых задач, назначение и возможности программы, ее основные характеристики, а также функциональные ограничения, накладываемые на область применения программы. Нельзя путать функциональные ограничения, отражающие что умеет и что не умеет делать программа, с условиями применения, накладывающими ограничения на конфигурацию ЭВМ и окружающего ПО.
3. Описание логической структуры. Дается структура про-
граммы с описанием функций составных частей – модулей, подпрограмм, процедур и связей между ними. Структуру следует представлять графически в виде схемы с необходимыми пояснениями. Далее следует описание каждого модуля программы, включающее в себя
а) его полное наименование и идентификатор; б) функциональное назначение; в) описание заложенного в него метода;
г) описание алгоритма в вербальной или графической форме; д) указание и обоснование языка программирования и/или средыпрограммирования, вкоторойсоздавалсяданныймодуль;
55
Таблица 8 – Символы для построения схем алгоритмов и программ
Наименование Обозначение Функция и размеры в мм
1. Процесс |
Выполнение операции или груп- |
|
пы операций, в результате кото- |
|
рых изменяется значение, форма |
|
представленияилирасположение |
|
данных |
2. Решение |
Выбор направления выполнения |
|
алгоритма или программы в за- |
|
висимостиотнекоторыхперемен- |
|
нных условий |
3. Модификация |
Выполнение операций, меняю- |
|
щих команды или группу ко- |
|
манд, изменяющих программу |
4. Предопреде- |
Использование ранее созданных |
ленный процесс |
и отдельно описанных алгорит- |
|
мов или программ |
5. Ручная опе- |
Автономный процесс, выполня- |
рация |
емый вручную или при помощи |
|
неавтоматически действующих |
|
средств |
6. Вспомогатель- |
Автономный процесс, выполня- |
ная операция |
емый устройством, не управляе- |
|
мым непосредственно процессо- |
56
Продолжение таблицы 8 |
|
|
|
|
|
Наименование |
Обозначение |
Функция |
|
и размеры в мм |
|
|
|
|
7. Слияние |
|
Объединениедвухилиболеемно- |
|
|
жеств в единое множество |
8. Выделение |
|
Удаление одного или несколь- |
|
|
ких множеств из единого мно- |
|
|
жества |
9. Группировка |
Объединениедвухилиболеемно- |
|
жеств с выделением нескольких |
|
других множеств |
10. Сортировка |
Упорядочение множества по за- |
|
данным признакам |
11. Ввод-вывод |
Преобразование данных в фор- |
|
му, пригодную для обработки |
|
(ввод) или отображения резуль- |
|
татов обработки (вывод) |
57
Продолжение таблицы 8 |
|
|
|
Наименование Обозначение |
Функция |
и размеры в мм |
|
|
|
12. Ручной |
Ввод данных вручную при помо- |
ввод |
щи неавтономных устройств с |
|
клавиатурой, переключателей, |
|
кнопок |
13. Автоном- |
Ввод-вывод данных в случае ис- |
ная память |
пользованиязапоминающегоус- |
|
тройства, не управляемого непо- |
|
средственно процессором |
14. Документ |
Ввод-вывод данных, носителем |
|
которых служит бумага |
15. Файл |
Представление организованных |
|
на основе общих признаков дан- |
|
ных, характеризующих в сово- |
|
купности некоторый объект об- |
|
работкиданных. Символисполь- |
|
зуется в сочетании с символами |
|
конкретных носителей данных, |
|
выполняющих функции ввода- |
|
вывода |
16. Магнит- |
Ввод-вывод данных, носителем |
ная лента |
которыхслужитмагнитнаялента |
58
Продолжение таблицы 8 |
|
|
|
Наименование Обозначение |
Функция |
и размеры в мм |
|
|
|
17. Магнитный |
Ввод-вывод данных, носите- |
диск |
лем которых служит магнит- |
|
ный диск |
18. Дисплей |
Ввод-вывод данных, если не- |
|
посредственноподключенное |
|
к процессору устройство вос- |
|
производит данные и позво- |
|
ляет оператору ЭВМ вносить |
|
изменениявпроцессеихобра- |
|
ботки |
19. Канал связи |
Передача данных по каналу |
|
связи |
20. |
Соединитель |
Указание связи между прера- |
|
|
ванными линиями потока, |
|
|
связывающими символы |
21. |
Пуск-останов |
Начало, конец, прерывание |
|
|
процесса обработки данных |
|
|
или выполнения программы |
22. |
Комментарий |
Связьмеждуэлементомсхемы |
|
|
и пояснением |
59
е) описаниеструктуры, организации, форматаиспособакодирования входных и выходных данных;
ж) перечень других модулей, программ или устройств, из которых вызывается или которые вызывает данный модуль;
з) текст на исходном языке или ссылку на текст, если он вынесен в приложение к отчету.
Описаниелогикидолжнобытьпривязаноктекступрограммы. Алгоритм программы изображается в виде схемы – функциональной сети. Узлами этой сети являются стандартные символы, основные из которых приведенные в таблице 8 (размер b равен 1,5a, размер a кратен 5 мм). Символы соединяются линиями потока, изображаемыми без стрелки, если они направлены сле- ва-направо или сверху-вниз и не имеют излома. В остальных случаях линии изображаются со стрелкой. Линии потока могут пересекаться или сливаться. Место слияния обозначается точкой на линии. Более подробно правила выполнения схем алгоритмов приведены в [3, 4].
Описание применения отражает сведения, необходимые для эффективного использования программы по назначению. Сюда входитследующаяинформацияизнесколькихдокументов– описания применения, руководства системного программиста, программиста и оператора.
1. Условия применения. Перечисляются требования к необходимымдляданнойпрограммытехническимсредствам– ктипу, характеристикам и конфигурации ЭВМ, к характеристикам вычислительной сети и других технических средств, в том числе и специализированных. Даются сведения об использовании программой оперативной и дисковой памяти. Указывается системное и прикладное программное обеспечение, необходимое для функционирования программы, включая операционные системы, системы управления базами данных, среды программирования, компиляторы, библиотеки и др. Описываются другие требования и условия организационного, технического и технологического характера.
2. Настройка программы. Дается перечень файлов и носителей, на которых поставляется программа. Описываются действия по установке программы и ее настройке на условия конкретного применения (настройка на состав технических и программных средств, выбор функций и др.). Перечисляются сооб-
60