Документиране на софтуерни продукти

Слайд 1

СОФТУЕРНО
ИНЖЕНЕРСТВО
ДОКУМЕНТИРАНЕ
НА СОФТУЕРНИ ПРОЕКТИ

Слайд 2

ДОКУМЕНТИРАНЕ

Разработването и използването на софтуерен проект е свързано със създаването на множество документи, които са с различно предназначение, структура и съдържание.

Най-общо тези документи могат да бъдат класифицирани в две групи:
ДОКУМЕНТИ, СВЪРЗАНИ С ПРОЦЕСА НА СЪЗДАВАНЕ НА СОФТУЕР
ДОКУМЕНТИ, ОПИСВАЩИ СЪЗДАДЕНИЯ ПРОГРАМЕН ПРОДУКТ

Слайд 3

ДОКУМЕНТИРАНЕ

ДОКУМЕНТИ, СВЪРЗАНИ С ПРОЦЕСА НА СЪЗДАВАНЕ НА СОФТУЕР

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

Слайд 4

ДОКУМЕНТИРАНЕ

ДОКУМЕНТИ, ОПИСВАЩИ СЪЗДАДЕНИЯ ПРОГРАМЕН ПРОДУКТ
В зависимост от предназначението си тази документация може да бъде СЪП-
РОВОЖДАЩА или ЕКСПЛОАТАЦИОННА.
Предназначението на СЪПРОВОЖДАЩАТА документация е да осигури ин-
формацията, необходима за разучаване и за внасяне на изменения в програми-
те. Тя може да включва:
описание на функционалните и нефункционални изисквания;
описание на архитектурата на софтуерната система- от какви основ-
ни компоненти се състои и какви са връзките между тях;
за всяка компонента — описание на спецификациите и на детайлния проект;
първичен текст на програмата. В някои организации има стандарт за
т. нар. вътрешно документиране на програмите чрез коментари.
описание на програмата, което включва предназначение, описание на
логиката, структура, компоненти, използвани методи и алгоритми, входна и из-
ходна информация, процедури за извикване и зареждане и др.

Слайд 5

ДОКУМЕНТИРАНЕ


Предназначението на ЕКСПЛОАТАЦИОННАТА документация е да осигури ин-
формацията, необходима за използването на софтуерната система от крайни потребители или администратори, които отговарят за функционирането на системата.

Документацията за АДМИНИСТРАТОРА се състои от:
ИНСТРУКЦИЯ ЗА ИНСТАЛИРАНЕ - съдържа указания, как да се инсталира
системата в конкретна потребителска среда и какви са техническите изисквания към хардуерната конфигурация.
РЪКОВОДСТВО ЗА АДМИНИСТРАТОРА - описва връзките с други системи,
обяснява извежданите съобщения и възможни действия при получаването им,
определя същността и начина на извършване на някои сервизни функции, като
архивиране, възстановяване на системата след срив, преконфигуриране и др.

Слайд 6

ДОКУМЕНТИРАНЕ

От изключително значение е и документацията за КРАЙНИЯ ПОТРЕБИТЕЛ.
Съществуват различни стандарти за съдържанието на потребителската документация — например стандарт ANSI/IEEE Std 1063-1987.
Потребителската документация може да се състои от две части — ОБУЧАВАЩА и СПРАВОЧНА.
ОБУЧАВАЩАТА ЧАСТ е предназначена за начинаещи потребители и описва постъпково как се използва софтуера. Това може да бъде например РЪКОВОДСТВО НА ПОТРЕБИТЕЛЯ (User manual, User Guide).
СПРАВОЧНАТА ЧАСТ е за потребители с по-голям опит, които се нуждаят от информация за възможностите на системата. Справочната част обикновено представя основните функции, подредени по определен начин за бързо търсене — например по азбучен ред.
Стилът на изложение зависи от някои характеристики на потенциалните
потребители, като образование, квалификация, ниво на компютърна грамотност и др. Ако в изискванията към системата има и описани характеристики на
потребителя, то те трябва да се вземат предвид.

Слайд 7

ИЗИСКВАНИЯ КЪМ ПОТРЕБИТЕЛСКАТА ДОКУМЕНТАЦИЯ

Правилност. Трябва да има пълно съответствие между функционира-
нето на софтуера и описанието в документацията. След всяка нова версия трябва да се обновява и документацията.
Пълнота и структурираност. Да има подробно съдържание и информацията да е структурира добре за последователно четене от потребителите с различна ква-
лификация и опит.
Ясен стил на изложение - недвусмислен и съобразен с термино-
логията в съответната област на приложение.
Ръководството за потребителя да бъде относително затворена систе-
ма, съдържаща необходимата и достатъчна информация, без да се използват препратки към трудно достъпни външни източници.

Слайд 8

Документирането е важен етап от софтуерния процес. За целта е необходимо всяка организация да определи свои вътрешни стандарти за начина на създаване на документацията и за самата документация — от кои документи ще се състои и как ще се идентифицират те, каква да е структурата и съдържанието на всеки документ, какви правила при оформянето на документите ще се спазват (обща структура на документите, начин на оформление на страниците, номерация, използвани шрифтове, цветове и др.), каква ще е процедурата за внасяне на изменения.
Съществуват автоматизирани средства, подпомагащи съставянето, оформянето и отпечатването на различните видове документи.



ДОКУМЕНТИРАНЕ

Слайд 9

ЛИТЕРАТУРА
Манева, Н., А. Ескенази, Софтуерни технологии, (2011);

http://www.literateprogramming.com/documentation.pdf

http://www.utdallas.edu/~chung/ieee-templates.pdf

Слайд 15

Весели
HI-TECH
коледни
празници

Регистрирайте се за пълен достъп