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

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