Методические указания для студентов специальности 1-40 01 02-03 «Информационные системы и технологии (издательско-полиграфический комплекс)» Минск 2010 (стр. 7 из 14)
Сведения об источниках в указателе (библиографические записи) следует располагать в порядке появления ссылок на источники в тексте пояснительной записки, нумеровать арабскими цифрами без точки и писать с абзацного отступа.
Ссылки на использованные источники следует приводить в квадратных скобках.
Без ссылок в тексте пояснительной записки разрешается использовать сведения, полученные на лекциях, семинарских, практических и лабораторных занятиях. Однако использованные учебные, учебно-методические материалы и пособия должны быть приведены и расположены в конце указателя.
Библиографические записи в указателе «Список использованных источников» должны быть выполнены в точном соответствии с требованиями стандарта ГОСТ 7.1-2003.
Библиографическая запись включает библиографическое описание, а также может содержать заголовок, термины индексирования (классификационные индексы и предметные рубрики), аннотацию (реферат), шифры хранения документа, справки о добавочных библиографических записях, дату завершения обработки документа, сведения служебного характера.
Библиографическое описание является основной частью библиографической записи и содержит библиографические сведения о документе, приведенные по определенным правилам, устанавливающим наполнение и порядок следования областей и элементов, и предназначенные для идентификации и общей характеристики документа.
Если у документа (книги, статьи и т. д.) один, два или три автора, то перед заглавием пишется только первый из них, после фамилии ставится запятая, далее идут инициалы. В сведениях об ответственности (после заглавия за косой чертой) записываются все авторы: один, два или три – в той форме, как в документе; инициалы, как правило, располагаются перед фамилией.
Если у документа более трех авторов, описание начинается с заглавия, т. е. все авторы пишутся только в сведениях об ответственности.
При необходимости сокращения количества авторов в сведениях об ответственности приводят фамилию и инициалы первого автора с добавлением сокращения «и другие», т. е. [и др.], или его эквивалента на латинском языке [et al.].
Обозначение индивидуального номера книги (ISBN) в библиографическом описании является обязательным.
Примеры библиографических записей приведены в приложении Д.
4 ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ
ПРОГРАММНОЙ ДОКУМЕНТАЦИИ
4.1 Общие положения
Алгоритм – точное предписание исполнителю совершить определенную последовательность действий для достижения поставленной цели за конечное число шагов.
Программа – данные, предназначенные для управления конкретными компонентами системы обработки информации в целях реализации определенного алгоритма.
Программы подразделяют на следующие виды:
- компонент – программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса;
- комплекс – программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса.
Программное средство (ПС) – объект, состоящий из программ, процедур, правил, а также, если предусмотрено, сопутствующих им документации и данных, относящихся к функционированию системы обработки информации.
Программное обеспечение (ПО) – совокупность программ системы обработки информации и программных документов, необходимых для их эксплуатации.
По видам выполняемых функций программное обеспечение подразделяется на системное, прикладное и инструментальное.
Программный модуль – программа или функционально завершенный фрагмент программы, предназначенный для хранения, трансляции, объединения с другими программными модулями и загрузки в оперативную память.
Различают следующие типы программных модулей:
- стандартные модули, входящие в язык программирования;
- пользовательские модули, предназначенные для упрощения работы программистов.
К программным относят документы, содержащие в зависимости от назначения данные, необходимые для разработки, производства, эксплуатации и сопровождения программ или программных средств.
В пояснительной записке к дипломному проекту (работе) рекомендуется приводить следующие виды программных документов:
- описание применения;
- описание программы;
- руководство системного программиста;
- руководство программиста;
- руководство оператора;
- текст программы.
Примечание – Описание применения и руководства системного программиста, программиста и оператора являются эксплуатационными программными документами.
4.2 Описание применения
Текст документа включает следующие части:
- назначение программы;
- условия применения;
- описание задачи;
- входные и выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные или объединять отдельные части.
В части «Назначение программы» указывают назначение, возможности программы, ее основные характеристики, ограничения, накладываемые на область применения программы.
В части «Условия применения» указывают условия, необходимые для выполнения программы (требования к необходимым для данной программы техническим средствам и другим программам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера и т. п.).
В части «Описание задачи» должны быть указаны определения задачи и методы ее решения.
В части «Входные и выходные данные» нужно указать сведения о входных и выходных данных.
4.3 Описание программы
Описание программы содержит следующие части:
- общие сведения;
- функциональное назначение;
- описание логической структуры;
- используемые технические средства;
- вызов и загрузка;
- входные данные;
- выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные части.
В части «Общие сведения» указывают:
- наименование программы;
- автора, дату создания, версию программы;
- программную среду и программное обеспечение, необходимые для функционирования программы, а также рекомендации по выбору версий и модификаций;
- языки программирования, на которых написана программа;
- новые возможности и отличия от предыдущих версий и модификаций.
В части «Описание логической структуры» указываются:
- алгоритм программы;
- используемые методы и типовые проектные решения;
- структура программы с описанием функций составных частей, их проблемной и машинной ориентации и связей между ними;
- связи программы с другими программами;
- используемые стандартные протоколы связи.
Описание логической структуры программы выполняют на основании исходного текста программы.
В части «Используемые технические средства» указывают типы ЭВМ и устройств, используемых при работе программы.
В части «Вызов и загрузка» описываются:
- способ вызова программы с соответствующего носителя данных;
- входные точки в программы.
Допускается упоминать адреса загрузки, сведения об использовании оперативной и внешней памяти, объем программы.
В части «Входные данные» указывают:
- характер и организацию входных данных;
- описание предварительной подготовки входных данных;
- формат, описание и способ кодирования входных данных.
В части «Выходные данные» описывают:
- характер и организацию выходных данных;
- формат, описание и способ кодирования выходных данных;
- возможности управления форматом и полнотой получаемых выходных данных.
Допускается иллюстрировать содержание частей пояснительными примерами, таблицами, схемами, графиками.
В приложении к описанию программы можно приводить различные материалы, которые нецелесообразно включать в документ «Описание программы».
4.4 Руководство системного программиста
Руководство системного программиста должно содержать следующие части:
- общие сведения о программе;
- структура программы;
- настройка программы;
- проверка программы;
- дополнительные возможности;
- сообщения системному программисту.
В зависимости от особенностей документа допускается объединять отдельные части или вводить новые.
В части «Общие сведения о программе» указываются назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.
В части «Структура программы» приводятся сведения о структуре программы, ее составных частях, связях между составными частями и связях с другими программами.
В части «Настройка программы» должно быть приведено описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.).
При необходимости приводят поясняющие примеры.
В части «Проверка программы» описываются способы проверки, позволяющие дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).
В части «Дополнительные возможности» должно быть приведено описание дополнительных функциональных возможностей программы и способов их выбора.
В части «Сообщения системному программисту» должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринимать по этим сообщениям.