Главная Теоретический материал Лабораторные работы Задачи Тесты Контакты

Узбекское Агентство
Связи и Информатизации



Ташкентский Университет Информационных Технологий


Кафедра
«Программное обеспечение информационных технологий»

Направления:

5521900Информатика и
информационные технологии,
5523500Защита информации,
5523600Электронная коммерция,
5811200Сервис (информационный сервис),
5811300Сервис (электронные и
компьютерные технологии),
5320200Информатика и
библиотековедение,
5140900Профессиональное образование
(по направлению
информатика и
информационные технологии).


Преподаватель дисциплины



Доцент
Чернев Дмитрий Алексеевич

Документация к программному обеспечению

Формальные требования к документации программного обес­печения описаны в ЕСПД (Единая система программной доку­ментации), неформально: состав документации к программному обеспечению состоит из описания внешнего эффекта ПО и описания его внутреннего устройства.

Первая часть документации, так называемая «Инструкция пользователю» (или «Руководство пользователю») предназначена для того, кто собирается использовать программное обеспечение, не вникая в подробности его внутреннего устройства; вторая («Руководство программисту») необходима при модификации ПО или при необходимости исправить в нем ошибку.

В целом, документация к программному обеспечению может содержать нижеперечисленные сведения:

1.  Наименование ПО и описание задачи, которую оно решает.

2.     Область применимости ПО, т.е. класс исходных данных, на который рас­считано ПО  и   степень   контроля   за   принадлежностью   данных  этому   классу.

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

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

5.  Исходные данные, необходимые для работы ПО; а также выдаваемые им результаты; побочный эффект изменения в памяти, который производит ПО и который не является его основной задачей, например, изменение входных параметров.

6.  Правила подготовки исходных данных на внешних носителях (если они применяются) и вид выдаваемой информации.

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

8.  Описания форм, объектов. Опись свойств форм и объектов.

9.  Тексты программ, процедур (в виде распечатки ЭВМ) с комментариями.

10. Тесты. Включаются только тестовые исходные данные и конечные результаты без промежуточных результатов.

Тесты необходимы при модификации программы, при пере­носе ее на   ЭВМ с той, на которой она отлаживалась.

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

11. Возможные модификации программного обеспечения. Указывается назначение модификации и те изменения, которые надо внести.

12. Инструкция (руководство) пользователю.


Назад


Главная Теоретический материал Лабораторные работы Тесты Контакты