Общие требования к программной документации

?

Структура отчета о нир?

Составные части:

1. Титульный лист

2. Список исполнителей (необязательно)

3. Реферат

4. Содержание (необязательно)

5. Перечень условных обозначений (необязательно)

6. Введение

7. Основная часть

8. Заключение

9. Список литературы

10. Приложения (необязательно)

Титульный лист по ГОСТ.

Список исполнителей не пишется, если их мало.

Рефератсодержит: название документа, объем, количество иллюстраций и таблиц, количество томов отчета (если больше одного), количество приложений.

«Отчет о НИР, 75 стр., 5 рис., 6 табл., 23 источника, 3 приложения»

После этого пишется перечень ключевых слов. Он должен характеризовать содержание документа. Общий объем (рекомендуемый) 5-15 слов. Он пишется для того, чтобы в автоматизированные системы отчет при необходимости мог быть включен. Пишется заглавными буквами, в именительном падеже, через запятую. Допускается не одно, а несколько слов.

Текст реферата– не более одной страницы. В нем кратко излагается объект исследования, цель работы, полученные результаты и их новизна, методы работы, степень внедрения, эффективность, область применения, основные конструктивные и технико-эксплуатационные характеристики.

Введение: В кратком виде история вопроса, постановка задачи, как можно решать задачу, на чем остановились, какие известные варианты решения задачи, и пишется, что далее в основной части.

Заключение: Подводятся итоги работы.

Введение и Заключение не номеруются !!!

(Заключение 1-3 страниц, введение столько же или раза в 2 больше).

Основная частьсостоит из нескольких разделов. Оптимальное число 4-6. (может быть 3, а может до десятка). Сами разделы в основной части нумеруются арабскими цифрами (1-5...). Объемы разделов должны быть соразмерны друг другу. В разделах могут быть подразделы и их, в свою очередь, тоже на подподразделы. Однако, надо соблюдать чувство меры.

Все страницы документа нумеруется подряд, арабскими цифрами. В ГОСТе не сказано, где их писать (главное, в одном месте).

Список используемых источников. Его можно формировать либо по алфавиту, либо по порядку появления в тексте. На большую часть источников должны быть ссылки в тексте - [5].

В приложении– дополнительный материал: емкие таблицы, тексты программ, доказательства, емкие расчеты, протоколы и акты испытаний, описание алгоритмов и программ, иллюстрации вспомогательного характера и т.д. Приложения обязательно все нумеруются арабскими цифрами (своя нумерация) и у каждого приложения должен быть заголовок.

Рисунки в тексте– должна быть подпись рисунка снизу. Либо сквозная нумерация рисунков по всему тексту, либо своя нумерация в каждом разделе. Рис 2.1. На каждый рисунок обязательно должны быть ссылка и каждый рисунок должен быть описан.

В статьях нет списка, титульного листа, содержания, приложений, но вместо реферата – аннотация – там пишется краткое содержание в настоящем времени (в незавершенной форме) – 1 абзац.

Требования к его оформлению

Общие требования к отчету:

• Четкость и логическая последовательность изложения материала

• Убедительность аргументации

• Краткость и точность формулировок исключающих возможность их неточного неоднозначного толкования

• Конкретность изложения результатов

• Обоснованность рекомендаций и предложений

Структурные части в отчете:

• Удобство, как для авторов отчета, так и для потребителей информации

По сути, весь материал можно и нужно найти в ГОСТе по оформлению УИРов.

Основные стадии разработки АС

Общепринятые стадии разработки АС

• Техническое задание

• Эскизный проект

• Технический проект

• Рабочий проект

• Внедрение

1. Техническое задание

3 этапа работы:

1.1 Обоснование необходимости разработки АС

Содержание работ на данном этапе:

• Постановка задачи

• Сбор исходных материалов

• Выбор и обоснование критериев эффективности и качества системы

• Обоснование необходимости проведения научно-исследовательских работ (НИР)

1.2 Научно-исследовательские работы (могу быть и могут не быть)

Содержание работы:

• Определение входных и выходных данных

• Предварительный выбор методов решения задач

• Обоснование целесообразности применения ранее разработанных систем или их частей

• Определение требований к техническим средствам

• Обоснование принципиальной возможности решения поставленной задачи

1.3 Разработка и утверждение технического задания

• Определение требований к системе

• Разработка технико-экономического обоснования системы

• Определение стадий, этапов и сроков разработки системы и документации на нее

• Определение необходимости проведения НИР на последующих стадиях

• Согласование и утверждение ТЗ (получение всех подписей, согласуется с финансистами, смежниками и т.д.)

2. Эскизный проект

2.1 Разработка эскизного проекта

• Предварительная разработка структуры входных и выходных данных

• Уточнение методов решения задач

• Разработка описания общего алгоритма решения задачи

• Уточнение технико-экономического обоснования

2.2 Утверждение эскизного проекта

• Разработка пояснительной записки

• Согласование и утверждение эскизного проекта

3. Технический проект

3.1 Разработка технического проекта

• Уточнение структуры входных и выходных данных

• Разработка алгоритма решения задач

• Определение формы представления входных и выходных данных

• Разработка структуры программного обеспечения

• Окончательное определение конфигурации технических средств

3.2. Утверждение технического проекта

• Составление плана мероприятий по разработке и внедрению программного обеспечения

• Разработка пояснительной записки

• Согласование и утверждение технического проекта

4. Рабочий проект

Этапы работы:

4.1 Разработка программного обеспечения

• Программирование и отладка комплекса программ

• Изготовление программы оригинала

4.2 Разработка программной и технической документации

• Разработка программных и технических документов в соответствии с требованиями действующих ГОСТов

4.3 Испытание системы и программ

• Разработка, согласование и утверждение порядка и методики испытаний

• Проведение различных видов испытаний (предварительных, государственных, межведомственных, приемосдаточных и т.д.)

• Корректировка программы и технической документации по результатам испытаний

5. Внедрение

5.1 Подготовка и передача системы и ее программного обеспечения

• подготовка и передача системы программной документации и программного обеспечения для сопровождения или изготовления

• оформление и утверждение акта о передачи системы и ее программного обеспечения на сопровождение или изготовление

• передача программного обеспечения в фонд алгоритмов и программ

примечание: допускается исключать стадию эскизного проекта. В обоснованных случаях допускается исключать эскизный и технический проекты. Необходимость этого обосновывается и указывается в техническом задании.

Допускается объединять, исключать отдельные этапы работ, а так же их содержание. Допускается вводить другие этапы работ по согласованию с заказчиком.

«Пограничная» точка для второго тестирования.