Врсте софтверске документације

Преглед садржаја:

Anonim

Ако сте икада видели компјутерски директоријум на мрежном диску у вашој компанији под називом "софтверски документи" или "софтверски водичи", а затим прегледали документе које сте имали дозволу за преглед, вероватно сте схватили да је број докумената и врста докумената за софтвер бројни. Такође се чини да се неки документи који се налазе у једној категорији односе и на друге категорије. Софтверски документи се користе у свакој фази типичног животног циклуса софтвера, тако да је то добро место за истраживање типа креираних докумената.

Предлог

Приједлог софтвера одређује захтјеве софтверског система и описује сврху софтвера и проблеме које рјешава. Такође ће одредити процијењено вријеме трајања пројекта и друге факторе који утјечу на приједлог.

Студија изводљивости

Студија изводљивости се обично одвија на почетку пројекта. Ова фаза одређује да ли софтверска фабрика задовољава пословне потребе корисника. Исход студије изводљивости одлучује да ли ће се пројекат наставити или не.

Потребне анализе

Анализа захтјева пружа средства за превођење пословних захтјева у аутоматизирана софтверска рјешења. Спољни консултант или руководство компаније обично обавља овај задатак. Захтеви претварају пословне захтеве у стварне спецификације за хардвер, софтвер и компоненте.

Десигн Доцументс

Пројектна документација пружа основу за развој софтвера да започне на техничком нивоу. Као што име сугерише, велики број графичких и текстуалних дизајна за базе података, интерфејсе, комуникације, веб развој и друге аспекте софтвера ће бити дизајниран прије него што кодирање може почети.

Документи кодирања

Документи кодирања односе се на стварни изворни код који се користи за програмирање софтвера. Код може бити написан на било којем броју доступних рачуналних језика, укључујући Јава, Ц ++, ПХП и стотине других компјутерских језика у зависности од система који се користи.

Тестинг Доцументс

Тимови за тестирање и програмери креирају тестне документе у различитим фазама животног циклуса софтвера. Програмери креирају документе за тестирање јединица за сопствени код. Тим за тестирање или други људи који нису директно повезани са кодом обавезно тестирају интеграције и тестирају пословне захтеве.

Кориснички водичи и маркетинг

Водичи за кориснике пружају упутства о томе како нови софтвер ради. Ако је систем велик и сложен, корисничка упутства се обично подржавају формалним течајевима обуке за особље. Маркетиншки документи илуструју предности новог софтверског система за потенцијалне купце.

Лиценце за софтвер

Издавање софтверских лиценци чини коришћење софтвера легалним што се тиче крајњег корисника. Корисници користе софтвер под условима софтверске лиценце издате од ауторске компаније. Немају сви софтверски строги услови лиценцирања, што је посебно тачно у случају отвореног кода. Уопштено, софтверски системи имају неки облик документа за лиценцирање који одређује како и гдје се софтвер може користити.