Выполнила: Чайко Екатерина Сергеевна студентка 3 курса, 31-И группы Старый Оскол, 2014 г.
Оглавление
Введение Составление программной документации-очень важный процесс. На каждый программный продукт должна разрабатываться документация двух типов: Для пользователей различных групп Для разработчиков
I. Документация на программное обеспечение 1.1. Определение документации Документация на программное обеспечение- печатные руководства пользователя, диалоговая (оперативная) документация и справочный текст, описывающие, как пользоваться программным продуктом.
1.2. Типы документации Существует четыре основных типа документации на ПО: Архитектурная/проектная Техническая Пользовательская Маркетинговая
1.3. Виды программных документов Спецификация Ведомость держателей подлинников Текст программы Описание программы Ведомость эксплуатационных документов Формуляр Описание применения Руководство системного программиста Руководство программиста Руководство оператора Описание языка Руководство по техническому обслуживанию Программа и методика испытаний Пояснительная записка Прочие документы
II. Составление программной документации 2.1. Пояснительная записка Содержание пояснительной записки по стандарту ГОСТ должно выглядеть следующим образом: Введение Назначение и область применения Технические характеристики Ожидаемые технико-экономические показатели Источники
2.2. Руководство пользователя Руководство пользователя содержит следующие разделы: Общие сведения о программном продукте Описание установки Описание запуска Инструкции по работе Сообщение пользователю
2.3. Руководство системного программиста Содержит следующие разделы: Общие сведения о программном продукте Структура Настройка Проверка Дополнительные возможности Сообщение системному программисту
2.4. Основные правила оформления программной документации Текстовые документы оформляются на листах формата А4. Поля на листе определяются в соответствии с общими требованиями: левое – не менее 30, правое – не менее 10, верхнее – не менее 15, а нижнее – не менее 20 мм.
2.5. Оформление списка литературы Список литературы должен включать все использованные источники. Сведения о книгах, фамилию и инициалы автора, заглавие книги, место издания, издательство, год издания.
Заключение Таким образом, были рассмотрены все поставленные вопросы, рассмотрены правила оформления расчетно-пояснительных записок при курсовом проектировании, основные правила оформления программной документации.
Список использованных источников