абрамова. Методические указания по курсовому проектированию по дисциплине Проектирование и разработка программного обеспечения
 Скачать 173.75 Kb.
|
3.8 Руководство пользователяПри формировании Руководства пользователя к разработанной системе необходимо руководствоваться следующими стандартами: IEEE Std 1063-2001, «IEEE Standard for Software User Documentation»; ГОСТ 19: ГОСТ 19.402-78 ЕСПД. Описание программы; ГОСТ 19.502-78 ЕСПД. Общее описание. Требования к содержанию и оформлению; ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению; ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению; ГОСТ 19.505-79 ЕСПД. Руководство оператора. Требования к содержанию и оформлению. При разработке Руководства пользователя рекомендуется придерживаться следующей структуры: Аннотация – краткое изложение содержания документа и его назначение Введение – информация о способах использования документа Содержание Возможные проблемы и пути их решения Глоссарий Предметный указатель. Руководство пользователя должно быть в первую очередь ориентировано на конечного пользователя, т.е. в полной мере учитывать его уровень подготовки. Поэтому, если конечными пользователями системы, помимо высококвалифицированных специалистов в области ПО, будут и обычные работники предприятия, никак не связанные с разработкой, использованием и модернизацией сложных информационных систем, рекомендуется сформировать отдельные документы для каждой группы пользователей: Руководство для системного администратора, Руководство для пользователя и т.п. Стиль руководства должен быть формально-нейтральным, изложение кратким и логичным, без дублирования. Избегайте жаргонных слов и метафор, не используйте синонимы для одного и того же термина. Вся основная терминология должна быть четко определена и отражена в глоссарии. Логично использование различных списков-инструкций для описания поведения пользователя при реализации определенных действий с помощью АС. Так же рекомендуется использовать повелительное наклонение (избегайте излишней вежливости) и настоящее время (у программного обеспечения нет прошлого и будущего, все события происходят здесь и сейчас). Допускается разумное использование сокращений какого-либо длинного термина, если он встречается в документе несколько раз. При этом при первом упоминании этого термина необходимо указать в скобках его аббревиатуру, которую и использовать далее по тексту. Приветствуется использование в руководстве разделов по функциям системы с крупными заголовками, коротких абзацев, графической информации (пиктограмм и иллюстраций). 3.9 Программная реализацияДанный раздел должен содержать листинг спроектированного программного обеспечения для АСОИУ с необходимыми, по мнению разработчика, комментариями. Текст программы оформляется в соответствии с ГОСТ 19.402-78 «ЕСПД. Описание программы». 3.10 ЗаключениеДанный раздел курсового проекта должен быть посвящен обоснованию выполнения целей и задач, указанных в Техническом задании на проектирование, а так же описании процента реализации требований к системе. 3.11 Источники разработкиДанный раздел курсового проекта содержит список всех литературных источников, включая интернет-ресурсы, с обязательной ссылкой на их использование в тексте пояснительной записки. 4.ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ КУРСОВОГО ПРОЕКТА4.1 Требования к оформлению пояснительной записки проектаПояснительная записка относится к проектной документации. Текст должен быть оформлен на листах формата А4 в соответствии с ГОСТ 2.105-95 в рамках с основной надписью по ГОСТ 2.104-68. Первый и заглавные листы разделов, первый лист содержания, первые листы приложений – в соответствии с формой 2 (ГОСТ 2.104-68), последующие листы — в соответствии с формой 2а (ГОСТ 2.104-68). Основная надпись рамки (штамп) выполняется чертежным шрифтом. Пояснительная записка выполняется в текстовом процессоре Microsoft Office Word или аналогичном. При наборе установить следующие размеры полей относительно внутренней границы рамки: верхнее — 0,5 см., нижнее — 0,5 см., левое — 0,5 см., правое — 0,5 см., установить одинарный интервал. Текст записки оформляется шрифтом Arial (14 к). Установить абзацный отступ 1 см. Использовать обычный шрифт, выделение курсивом, полужирным и подчеркиванием не допускается. Текст пояснительной записки разделяют на разделы и подразделы. Разделы должны иметь порядковые номера в пределах всего документа, обозначенные арабскими цифрами без точки и записанные с абзацного отступа. Подразделы должны иметь нумерацию в пределах каждого раздела, номер подраздела состоит из номера раздела и подраздела, разделенных точкой. В конце номера подраздела, а также после названия раздела или подраздела, точка не допускается. Каждый раздел начинается с нового листа. Для оформления заголовков и подзаголовков любого уровня вложения использовать обычный шрифт Arial (16 к), не выделяя прописными буквами. Интервал между заголовками разделов, подразделов и текстом 12 пт (верхний и нижний). Допускается нумерация подразделов не более четырёх уровней вложения (например: 2.3.4.2 Требования…). Пример оформления заголовков приведен в приложении А. Выравнивание текста по ширине страницы, заголовков — по левому краю страницы, перенос слов не допускается. Нумерация страниц проставляется в форме 2, 2а (ГОСТ 2.104-68) в поле 7 без использования дополнительных знаков (шрифт в соответствии со стилем шрифта штампа). В форме 2 (ГОСТ 2.104-68) в поле 8 проставляется общее количество листов раздела (содержания, приложения). Титульные листы, задание – не нумеруются. Лист оглавления является вторым листом пояснительной записки, нумерация листов сквозная по всему документу. Пример оформления оглавления приведен в приложении Б. |