Выбирается по согласованию с преподавателем
Скачать 307.45 Kb.
|
1 2
ТЕКСТ ПРОГРАММЫ (ГОСТ 19.401-78)Требования к оформлению текста программы достаточно просты и естественны для грамотного программиста. Основное, чем требуется руководствоваться при создании этого документа – это то, что текст программы должен быть удобочитаемым. По-прежнему обязательным является составление информационной части - аннотации и содержания. Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования. Текст каждого программного файла начинается с "шапки", в которой указывается: наименование программы, автор, дата создания программы, номер версии, дата последней модификации. Обязательными являются комментарии, а также строгое соблюдение правил отступа. Помните, оправдать можно даже неумение создавать программную документацию. А некрасивый текст программы – никогда. Ссылки на то, что этот текст понятен самому автору, всерьез не воспринимаются. Тексты программ должно быть не стыдно давать читать другим людям. Ниже приведен пример подобного хорошо читаемого текста программы (взят с сайта Николая Гехта, e-mail:geht@omskreg.ru, http://users.omskreg.ru/~geht) /* Исходные тексты Windows'98 Автор: Nobody Really Source Code to Windows 98 */ #include "win31.h" #include "win95.h" #include "evenmore.h" #include "oldstuff.h" #include "billrulz.h" #include "monopoly.h" #define INSTALL = HARD char make_prog_look_big[1600000]; void main() { while(!CRASHED) { display_copyright_message(); display_bill_rules_message(); do_nothing_loop(); if(first_time_installation) { make_50_megabyte_swapfile(); do_nothing_loop(); totally_screw_up_HPFS_file_system(); search_and_destroy_the_rest_of_OS/2(); disable_Netscape(); disable_RealPlayer(); disable_Corel_Products(); hang_system(); } write_something(anything); display_copyright_message(); do_nothing_loop(); do_some_stuff(); if (still_not_crashed) { display_copyright_message(); do_nothing_loop(); basically_run_windows_3.1(); do_nothing_loop(); do_nothing_loop(); } } if (detect_cache()) disable_cache(); if (fast_cpu()) { set_wait_states(lots); set_mouse(speed, very_slow); set_mouse(action, jumpy); set_mouse(reaction, sometimes); } /* printf("Welcome to Windows 3.11"); */ /* printf("Welcome to Windows 95"); */ printf("Welcome to Windows 98"); if (system_ok()) crash(to_dos_prompt) else system_memory = open("a:\swp0001.swp", O_CREATE); while(something) { sleep(5); get_user_input(); sleep(5); act_on_user_input(); sleep(5); } create_general_protection_fault(); } ПРОГРАММА И МЕТОДИКА ИСПЫТАНИЙ (ГОСТ 19.301-79)В этом документе содержится описание того, что и как необходимо сделать, дабы убедиться (и убедить Заказчика) в правильности работы программы. Фактически, этот документ является определяющим для приемо-сдаточных испытаний. Грамотно составленная программа и методика испытаний – это залог подписания акта сдачи-приемки, т.е. того, во имя чего вы потратили столько сил и времени. Формально этот ГОСТ используется для разработки документов планирования и проведения испытательных работ по оценке готовности и качества программной системы. Документ содержит описание объекта и цели испытаний, требования к программе и к программной документации, средства и порядок испытаний, а также описание тестовых примеров. Составные части этого документа проще и нагляднее описывать сразу в виде примеров. Объект испытаний Пример: Объектом испытаний является программа …, предназначенная для … Цель испытаний Пример: Проверка надежности функционирования программы. Требования к программе Пример: Функционирование программы не должно приводить к сбою (фатальному нарушению работы системы). Организация диалога должна предусматривать защиту от ввода некорректных данных. Программа должна выдавать диагностику состояния системы и сообщения о любых возникших ошибках … и т.п. Требования к программной документации Пример: Состав программной документации, предъявляемой на испытании: описание программы (ГОСТ 19.402-78); программа и методика испытаний (ГОСТ 19.301-79); текст программы (ГОСТ 19.401-78). Средства и порядок испытаний Пример: Программа работает в соответствии с условиями эксплуатации ОС MS DOS (версия не ниже 3.0) на ПК типа IBM PC/AT, а также на совместимых с ним. Для работы необходим также адаптер EGA (VGA). Порядок проведения испытаний: 1. Запуск программы осуществляется …. 2. Выбирается … 3. Нажимается … 4. Последовательно выбираются … Тестовые примеры Пример: Для проведения испытаний предлагаются …, описание которых содержатся в файлах …Содержимое тестовых файлов и результаты работы программы приведены в Приложении 1. И, наконец, рассмотрим последний интересующий нас стандарт ЕСПД, который называется ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ (ГОСТ 19.106-78)Стандарт устанавливает правила выполнения программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения и предусмотренных стандартами ЕСПД. С содержательной точки зрения это – не самый “творческий” ГОСТ. Множество мелких, подробных деталей, возможно, читать утомительно, однако необходимо. Согласно этому стандарту следует оформлять, вообще говоря, все, что приходится писать разработчику, в т.ч. и документацию, и статьи, и т.д. Поэтому рассмотрим его более подробно. Общие требования. Вписывать в программные документы, выполненные машинописным, машинным и рукописным способами, отдельные слова, формулы, условные знаки (от руки чертежным шрифтом), буквы латинского и греческого алфавитов, а так же выполнять схемы и рисунки необходимо черными чернилами или тушью. Опечатки и графические неточности, обнаруженные в процессе выполнения допускается исправлять подчисткой некачественно выполненной части текста (чертежа) и нанесением на том же листе исправленного текста (графики) машинописью или черной тушью в зависимости от способа выполнения документа. Повреждение листов документов, помарки и следы не полностью удаленного текста (графики) не допускаются. Программные документы оформляют на листах формата А4. Кроме того: допустимо оформление на листах формата А3; при машинном способе выполнения документа допускаются отклонения размеров листов, соответствующих форматам А4 и А3, определяемые возможностями применяемых технических средств; на листах форматов А4 и А3, предусматриваемых выходными характеристиками устройств вывода данных, при изготовлении документа машинным способом; при изготовлении документа типографским способом возможно использование листов типографических форматов. Расположение материалов программного документа осуществляется в следующей последовательности: титульная часть: - лист утверждения (не входит в общее количество листов документа); - титульный лист (первый лист документа); информационная часть: - аннотация; - лист содержания; основная часть: - текст документа (с рисунками, таблицами и т.п.); - перечень терминов и их определений; - перечень сокращений; - приложения; - предметный указатель; - перечень ссылочных документов; часть регистрации изменений: - лист регистрации изменений. Построение документа. При необходимости допускается делить документ на части. Деление на части осуществляется на уровне не ниже раздела. Каждую часть комплектуют отдельно, при этом в конце содержания первой части следует перечислить названия остальных частей. Допускается включение в документ частей текста программы, оформляемых в соответствии с правилами языка, на котором написан текст программы. Аннотацию размещают на отдельной странице (страницах), снабжают заголовком "АННОТАЦИЯ", нумеруют и включают в содержание документа. Содержание документа размещают на отдельной странице (страницах), снабжают заголовком "СОДЕРЖАНИЕ" и включают в общее количество страниц документа. В содержании документа дается перечисление наименований разделов и подразделов и номеров страниц. Текст каждого документа, при необходимости, разбивается на пункты, а пункты - на подпункты, независимо от того, разделен документ на части, разделы и подразделы или нет. Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста. Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной). Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят. Каждый раздел рекомендуется начинать с нового листа. Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой. Разделы должны иметь порядковый номер (1, 2 и т.д.) Текст документа. Текст документа должен быть кратким, четким, исключающим возможность неверного толкования. Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов. Необходимые пояснения к тексту документа могут оформляться сносками. Сноска обозначается цифрой со скобкой, вынесенной на уровень линии верхнего обреза шрифта. Если сноска относится к отдельному слову, знак сноски помещается непосредственно возле этого слова, если же к предложению в целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведенной в левой части страницы. Иллюстрации. Иллюстрации могут быть расположены в тексте документа и (или) в приложениях. Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа. В приложениях иллюстрации нумеруются в пределах каждого приложения в порядке, установленном для основного текста документа. Ссылки на иллюстрации дают по типу: "рис.12" или "(рис.12)". Иллюстрации могут иметь тематический заголовок и подрисуночный текст, поясняющий содержание иллюстрации. Формулы. Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы. В пределах всего документа или его частей, в случае деления документа на части, формулы имеют сквозную нумерацию. Ссылки в тексте на порядковый номер формулы дают в скобках, например: "в формуле (3)". При делении документа на части номер части ставится перед порядковым номером формулы и отделяется от последней точкой, например: "в формуле (1.4)". Значение символов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова "где", без двоеточия после него. Ссылки. В программных документах допускаются ссылки на стандарты и другие документы. Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). Допускается указывать только обозначение документа и (или) разделов без указания их наименований. Ссылки на отдельные подразделы, пункты и иллюстрации другого документа не допускаются. Допускаются ссылки внутри документа на пункты, иллюстрации и отдельные подразделы. Примечания. В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные. Одно примечание не нумеруется. Тогда после слова "Примечание" ставят точку. Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. И в этом случае после слова "Примечание" ставят двоеточие. Текст примечаний допускается печатать только через один интервал. Сокращения. Сокращения слов в тексте и надписях под иллюстрациями не допускаются, за исключением: сокращений, установленных в ГОСТ 2.316-68, и общепринятых в русском языке; сокращений, применяемых для обозначения программ, их частей и режимов работы, в языках управления заданиями, в средствах настройки программы и т.п., обозначаемых буквами латинского алфавита. Приложения. Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений. Приложения оформляют как продолжение данного документа на последующих страницах или выпускают в виде отдельного документа. Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова "Приложение" и иметь тематический заголовок. При наличии в документе более одного приложения все приложения нумеруют арабскими цифрами (без знака ‘№’), например: Приложение 1, Приложение 2 и т.д. При выпуске приложения отдельным документом, на титульном листе под наименованием документа следует указывать слово "Приложение", а при наличии нескольких приложений указывают также его порядковый номер. |
1 2
Похожие:
 | 1 История развития спортивного плавания Построить график рекордов... Кафедра теории и методики спортивного и синхронного плавания, аквааэробики, прыжков в воду и водного поло | | 1 История развития спортивного плавания Построить график рекордов... Кафедра теории и методики спортивного и синхронного плавания, аквааэробики, прыжков в воду и водного поло |
 | Основная часть содержит вопросы для обсуждения По согласованию с преподавателем проводят исследования в виде домашнего задания, компьютерной формы сбора и обработки данных и дают... | | Выбирается из таблиц Изменять тему возможно только по договоренности... «Математическое обеспечение и администрирование информационных систем». В соответствии с этими же стандартами данная дисциплина должна... |
| Программа по формированию навыков безопасного поведения на дорогах... В течение семестра студенту необходимо подготовить реферат по одной из предложенных тем. По согласованию с преподавателем можно предложить... | | Выбирается из предложенных преподавателем. Задачей студента является... Реферат представляет собой начальную форму самостоятельной научной работы студента. Написание реферата имеет своей целью |
| Industrial Organization Задание для выполнения эссе (реферата) Тема эссе (реферата) выбирается студентом самостоятельно из списка тем, предложенных преподавателем. Рекомендуемый объем эссе – 5... | | Обычно выбирается из общего списка и согласовывается с учителем или... Обычно целью реферата является — демонстрация знаний учащихся по конкретной предмету, теме или проблеме и практических навыков анализа... |
| Выбирается магистрантом самостоятельно. Магистрант может выбрать... Реферат печатается с помощью компьютера на одной стороне листа белой бумаги формата А4 через полтора интервала шрифтом 14 Times New... | | Учебно-методический комплекс дисциплины Умкд составлен преподавателем филиала Э. Ю. Радыгиной, ст преподавателем, Короленко А. Ю., к п н., доцентом |
| Рекомендации студенту по выполнению рефератА (курсовой работы) Процесс... Выбор темы является весьма ответственным этапом выполнения реферата (курсовой работы), тема выбирается студентами самостоятельно... | | Программа по формированию навыков безопасного поведения на дорогах... Умкд составлен преподавателем филиала Радыгиной Э. Ю., ст преподавателем, Сазоновой В. А.,к ф н |
| Макроэкономика Библиографический список «2», «3-», «3», «3+», «4-», «4», «4+»,«5-», «5», «5+», принятым в рэш. Сначала выписаны баллы из ста, поставленные преподавателем... | | Экзаменационный тест по экономике «2», «3-», «3», «3+», «4-», «4», «4+»,«5-», «5», «5+», принятым в рэш. Сначала выписаны баллы из ста, поставленные преподавателем... |
| Программа научно-практической конференции «2», «3-», «3», «3+», «4-», «4», «4+»,«5-», «5», «5+», принятым в рэш. Сначала выписаны баллы из ста, поставленные преподавателем... | | «Рассмотрено» «Утверждаю» Методическим Директор советом школы «2», «3-», «3», «3+», «4-», «4», «4+»,«5-», «5», «5+», принятым в рэш. Сначала выписаны баллы из ста, поставленные преподавателем... |
