Стадии и этапы составления программ и программной документации

Министерство  сельского хозяйства РФ

ФГОУ  ВПО «Рязанский государственный агротехнологический университет

имени П.А. Костычева» 

Кафедра информационных технологий в экономике 
 
 

Контрольная работа по информатике 

на тему: «Стадии и этапы составления  программ и программной документации»

                                                             
 

                                                          Выполнила: студентка 1 курса

                                                               Учётно-финансового факультета

                           12А группы

                                               специальности: «Бухгалтерский учёт,

                                 анализ и аудит»

                                                 Зачётная книжка №19108

                                                              Ульянова Елизавета Михайловна 

                                                       Проверила: д.э.н., профессор

                                                         Шашкова Ирина Геннадьевна 
 

Рязань 2009 г.

Содержание 
 
 

Введение 3 

Часть 1

Введение 5

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

2. Общие положения 7

3. Содержание  разделов 7

4. Стадии и  этапы разработки 10

Вывод 15 

Часть 2

Задание 1 16

Задание 2.1 17

Задание 2.2 18 

Вывод 19 

Список использованной литературы 20 

Приложение 21 
 
 
 
 

Введение 

   Информатика есть наука о способах получения, накоплении, хранении, преобразовании, передаче и использовании информации. Она включает дисциплины, так или иначе относящиеся к обработке информации в вычислительных машинах и вычислительных сетях: как абстрактные, вроде анализа алгоритмов, так и довольно конкретные, например, разработка языков программирования.

   У информатики много разделов; один из них – программирование.            Программирование — процесс и искусство создания компьютерных программ и/или программного обеспечения с помощью языков программирования. Программное обеспечение представляет собой либо данные для использования в других программах, либо алгоритм, реализованный в виде последовательности инструкций для процессора.

   В технической документации к программному продукту всё должно быть изложено максимально внятно, даже избыточно внятно; все объекты: рисунки, графики, диаграммы, таблицы, схемы - пронумерованы и легко находимы в тексте. Все термины должны быть легко произносимы и воспринимаемы на слух. Все элементы интерфейса (особенно значки) должны допускать краткое и четкое словесное обозначение: "стрелка", "человечек", "дискета" и пр.

В подавляющем  большинстве случаев пользователь обращается к программному продукту, потому что рассчитывает, что он выполнит хотя бы одну из трех функций:

- сделает возможным или облегчит ему решение практических задач;

- существенно расширит круг его возможностей в части решения практических задач;

- создаст для него принципиально новую привлекательную сферу деятельности.

     Иными словами, программный продукт позволяет делать то, что без него делать или существенно труднее, или вообще невозможно.

   Это тема является актуальной, ведь цель технической документации - обеспечить пользователю оперативное и комфортное получение необходимой ему информации и служить вспомогательным пособием для сотрудников службы технической поддержки. А это сложно и очень важно. Поэтому темой своей контрольной работы я выбрала «Этапы составления программ и программной документации». 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Часть 1 

Введение

   Создание программ и программной документации – это самый тяжёлый этап программистской работы. Между прочим, дело уже дошло до того, что, говорят, появилась даже особая специальность – технический писатель – это человек, который умеет создавать программную документацию.

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

  Важно создать первый пакет программной документации (ПД), этого будет достаточно, чтобы на его основе строить все последующие, используя его как образец или шаблон. Для начала необходимо вооружиться ГОСТами. В них входит интересующая нас Единая Система Программной Документации (ЕСПД).

   Единая  система программной  документации – это комплекс государственных стандартов, устанавливающих взаимосвязанные правила разработки, оформления и обращения программ и программной документации.

   Например,

ГОСТ 19.001-77 ЕСПД. Общие положения.

ГОСТ 19.101-77 ЕСПД. Виды программ и программных  документов.

ГОСТ 19.102-77 ЕСПД. Стадии разработки.

ГОСТ 19.103-77 ЕСПД. Обозначение  программ и программных  документов.

ГОСТ 19.104-78 ЕСПД. Основные надписи.

ГОСТ 19.105-78 ЕСПД. Общие требования к программным  документам.

ГОСТ 19.106-78 ЕСПД. Требования к  программным документам, выполненным печатным способом.

ГОСТ 19.201-78 ЕСПД. Техническое  задание. Требования к содержанию и  оформлению.

ГОСТ 19.202-78 ЕСПД. Спецификация. Требования к содержанию и оформлению.

  

  

   При составлении  программ нельзя использовать никакие цитаты и вторичные источники. ГОСТ – это закон. И тем более, «никаких Интернетов» (представьте себе суд, выносящий приговор, пользуется распечаткой Уголовного Кодекса, ”скаченного” с какого-нибудь сайта!)».

   В состав ЕСПД входят:

·   основополагающие и организационно-методические стандарты;

·   стандарты, определяющие формы и содержание программных документов, применяемых при обработке данных;

·   стандарты, обеспечивающие автоматизацию разработки программных документов.

   Вообще перечень документов ЕСПД очень обширен. Основная часть комплекса ЕСПД была разработана в 70-е и 80-е годы.

   Итак, стандарты ЕСПД упорядочивают процесс документирования программных систем.

   При создании  программ каждый документ желательно предварять некоторым введением. Во введении говорятся общие слова: об актуальности, о необходимости и т.п. Цель Исполнителя здесь – показать значимость и необходимость выполнения этой работы.  

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

   Техническое задание (ТЗ) содержит совокупность требований к ПС (программным средствам) и может использоваться как критерий проверки и приёмки разработанной программы. Поэтому достаточно полно составленное (с учетом возможности внесения дополнительных разделов) и принятое заказчиком и разработчиком, ТЗ является одним из основополагающих документов проекта ПС. 
 
 

2. Общие положения

   Техническое задание оформляют на листах формата А4 или А3, как правило, без заполнения полей листа. Номера листов (страниц) проставляют в верхней части листа над текстом.

       Техническое задание должно содержать следующие разделы:

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

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

3. Содержание разделов

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

  

    В разделе основание для разработки должны быть указаны:

  • документ (документы), на основании которых ведется разработка;
  • организация, утвердившая этот документ, и дата его утверждения;
  • наименование и (или) условное обозначение темы разработки.
 

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

   Например, программа представляет собой ядро автоматизированного рабочего места (АРМ) разработчика непрерывных линейных систем автоматического управления (САУ), позволяющее пользователю решать задачи анализа простых моделей. 

   Раздел  технические требования к программе или программному изделию должен содержать следующие подразделы:

  • требования к функциональным характеристикам;
  • требования к надежности;
  • условия эксплуатации;
  • требования к составу и параметрам технических средств;
  • требования к информационной и программной совместимости;
  • требования к маркировке и упаковке;
  • требования к транспортированию и хранению;
  • специальные требования.

   Иными словами, здесь начинается конкретика. Описывается то, что должна делать программа и как она должна выглядеть. 

   Требования  к функциональным характеристикам. Здесь должны быть указаны требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам и т.п. 

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

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

   Требования  к составу и  параметрам технических  средств. Указывают необходимый состав технических средств с указанием их технических характеристик. 

   Требования  к информационной и программной  совместимости. Здесь должны быть указаны требования к информационным структурам на входе и выходе и методам решения, исходным кодам, языкам программирования. При необходимости должна обеспечиваться защита информации и программ. 

   Требования  к маркировке и  упаковке и требования к транспортированию  и хранению. «Являются достаточно экзотическими». Указывают требования к маркировке программного изделия, варианты и способы упаковки, условия транспортирования, места хранения, условия хранения. 

   Технико-экономические  показатели. Этот самый сложный для программиста пункт. В этом разделе должны быть указаны: ориентировочная экономическая эффективность, предполагаемая годовая потребность (например, предполагаемое число обращений к комплексу в целом в год - 365 сеансов работы), экономические преимущества разработки по сравнению с лучшими отечественными и зарубежными образцами или аналогами. 
 
 

   4. Стадии и этапы разработки

   Здесь описываются стандартные этапы.

     Основными и непременными стадиями и этапами являются само техническое задание, эскизный проект, технический и рабочий проекты.

  

   Стадии разработки программ и программной документации для вычислительных машин, комплексов и систем независимо от их назначения и области применения.

Стадии  разработки Этапы работ Содержание работ
 
 
 
 
 
 
 
 
 
 
 
 
Техническое задание 
 
 
 
 
 
 
 
 
 
 
  
 
 
Обоснование необходимости разработки программы		 Постановка  задачи.

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

Выбор и обоснование  критериев эффективности и качества разрабатываемой программы.

Обоснование необходимости проведения научно-исследовательских работ.

 
 
 
 
 
 
Научно-исследовательские  работы		 Определение структуры  входных и выходных данных.

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

Обоснование целесообразности применения ранее разработанных  программ.

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

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

 
Разработка  и утверждение технического задания		 Определение требований к программе.

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

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

Выбор языков программирования.

Определение необходимости  проведения научно-исследовательских  работ на последующих стадиях.

Согласование  и утверждение технического задания.

 
 
 
 
 
Эскизный  проект		  
 
 
 
Разработка  эскизного проекта		 Предварительная разработка структуры входных и  выходных данных.

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

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

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

 
Утверждение эскизного проекта		 Разработка  пояснительной записки.

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

 
 
 
 
 
 
 
 
 
Технический проект		  
 
 
 
 
 
Разработка технического проекта		 Уточнение структуры  входных и выходных данных.

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

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

Определение семантики  и синтаксиса языка.

Разработка структуры  программы.

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

 
 
 
Утверждение технического проекта		 Разработка  плана мероприятий по разработке и внедрению программ.

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

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

 
 
 
Рабочий проект		 Разработка  программы Программирование  и отладка программы
Разработка  программной документации Разработка  программных документов в соответствии с требованиями ГОСТ 19.101-77.
Испытания программы Разработка, согласование и утверждение программы и  методики испытаний.

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

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

 
 
 
 
Внедрение		  
 
 
 
Подготовка  и передача программы		 Подготовка  и передача программы и программной  документации для сопровождения  и (или) изготовления.

Оформление и  утверждение акта о передаче программы на сопровождение и (или) изготовление.

Передача программы  в фонд алгоритмов и программ.

 
 

 Текст каждого программного файла начинается с "шапки", в которой указывается:

·        наименование программы;

·        автор;

·        дата создания программы;

·        номер версии;

·        дата последней модификации. 

  Программный документ может быть представлен на различных типах носителей данных и состоит из следующих условных частей:

  • титульной;
  • информационной;
  • основной.
 

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

·        текст программы;

·        описание программы;

·        программа и методика испытаний;

·        описание применения;

·        руководство пользователя. 
 

   В Приложениях, при необходимости, приводят:

·        перечень научно-исследовательских  и других работ, обосновывающих разработку;

·        схемы алгоритмов, таблицы, описания, обоснования, расчеты и другие документы, которые могут быть использованы при разработке;

·        другие источники разработки. 

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

• человеческий фактор - количество исполнителей, профессиональный уровень, организационная структура коллектива, наличие опыта в соответствующей проблемной области, опыт выполнения процессов и др.;

• особенности  проблемной области - тип приложений, новизна проблематики, изменчивость, внешние ограничения и др.;

• факторы процесса разработки - модель жизненного цикла, методы, технологии, инструментальные средства, язык программирования и  др.;

• факторы продукта - релизы (очереди поставки) системы, объём (размер) системы, необходимые характеристики качества (например, надежность, переносимость) и др.;  
 

Вывод

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

Часть 2.

Задание 1. 

Схема, отражающая устройство ПК. 

Выполнение:

  1.  Создаём Документ Microsoft Word

    (Щёлкаем правой  кнопкой мыши на рабочий стол  или в какой – либо папке,  выбираем вкладку Создать, Документ  Microsoft Word).

  1. На панели инструментов выбираем значок Прямоугольник. Далее появляется область Создайте рисунок. В ней с помощью левой кнопки мыши рисуем необходимые нам прямоугольники. (Их можно редактировать по своему усмотрению (с помощью стрелок)). Чтобы нарисовать линии, выбираем на панели инструментов значок Линия и проводим необходимые преобразования.
  2. Чтобы изменить цвет, тип линий, двойным нажатием щёлкаем на прямоугольник/линию.
  3. Чтобы добавить текст в прямоугольник, щёлкаем правой кнопкой мыши в его область, выбираем Добавить текст.
  4. Файл, Сохранить как, выбираем место, в которое необходимо сохранить документ.
Задание 2.
1.                
                 
  А B            
1 груши 12            
2 яблони 17            
3 сливы 5            
                 
 
 
                
                 
                 
                 
                 
                 
                 
                 
                 
                 
                 
                 
                 
                 
Выполнение:                
1. Создаём Лист Microsoft Excel            
(Щёлкаем  правой кнопкой мыши на рабочий  стол или в какой - либо папке,  выбираем  
вкладку Создать, Лист Microsoft Excel).          
2. Заполняем указанные ячейки данными.          
3. Для того чтобы построить диаграмму  по заданным значениям выбираем    
команду Вставка, Диаграмма.            
Выбираем  тип диаграммы, стандартная/нестандартная.        
В нашем случае Стандартная, Круговая, вид: Объёмный вариант разрезанной круговой  
диаграммы.              
Нажимаем  клавишу Далее, чтобы выбрать  Диапазон, выделяем левой клавишей мышы столбик 
с данными, клавиша Далее, Готово.          
Диаграмму можно редактировать, выбирая разные пункты меню.      
4. Файл, Сохранить как, выбираем место в которое необходимо сохранить документ.  
 
 
 
 
 
 
 
 
 
 
 
 
 
Задание 2.
2.                  
                   
  А B C D E        
1 x     #ЗНАЧ! #ЗНАЧ!        
2   y              
3     z            
                   
                   
Выполнение:

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

   
для электронных таблиц              
1. Cоздаём Лист Microsoft Excel            
2. Располагаем переменные величины  в указанных ячейках.      
х-А1, y-B2, z-C3                
3. Далее в любой свободной ячейке  набираем формулу. Например, в  D1 и E1.  
В строке формул также можно это  сделать.          
В случае а) =(2*А1)-3,5*СТЕПЕНЬ(В2;2)          
В случае б) =((А1+В2)/(1-С3))-0,7*А1          
Если  мы вместо х,у,z напишем любые числа, то в ячейках D1 и E1 автоматически  появится
какое-либо число, посчитанное по нашей формуле а) и б)      
4. Формулы можно редактировать  в строке формул.        
5. Выбираем команду Файл, Сохранить  как,  выбираем  место в которое  необходимо
сохранить документ.              
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Вывод 

   Таким  образом, документация используется для поиска и получения информации. Однако существуют различные сценарии поиска информации, и соответственно, использования документации. Предсказывая возможные варианты поведения пользователя, можно свести эти сценарии к нескольким основным:

  • "Быстрый старт", т. е. поиск сведений об установке, настройке, запуске и начале работы с программным продуктом.
  • Ознакомительное чтение, дающее возможность освоить работу с продуктом в целом и способы решения наиболее типичных практических задач.
  • Целевой поиск путей решения той или иной конкретной практической задачи с помощью продукта.
  • Запрос и получение исчерпывающей справочной информации по избранному режиму(ам), элементу(ам) интерфейса, функции(ям) и т. д.
  • Детальное знакомство с программным продуктом и нюансами его работы.
 

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

Список использованной литературы 
 

1. Карпов В.Э.  «Об оформлении программной документации» 

2. Меняев М.Ф  «Информатика и основы программирования. Учебное пособие» 

3. Роганова Е.А. «Основы информатики и программирования» 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Приложение