Dokumentācija lielos projektos

Abstract

Šajā darbā ir aprakstītas metodes, izmantojot kuras tiek veidota projektu tehniskā dokumentācija. Šīs metodes noteiktas to vājās un stiprās puses un izmantošanas apgabali. Darbā ir apskatīti abi varianti: dokumentācija, kas ir tapusi projektēšanas fāzē, un no koda veidotā dokumentācija. Praktiskajā daļā ir apskatīta dokumentācijas aspekti dažāda lieluma projektos. Tika apskatīti šīs dokumentācijas vairāki paraugi. Līdz ar to, ka darba autors piedalās šo projekta uzturēšanā un attīstībā, ir doti secinājumi par darba uzturēšanas darba efektivitāti ar un bez tehniskās dokumentācijas un par dokumentācijas veidošanas darbu atmaksāšanos.

This paper has reviewed methods using what technical documentation is being created. The weak and strong aspects of these methods are identified and possible usage domains are shown. This paper has reviewed both sides of documentation creation — reverse and forward engineering. Practical part of the paper shows the aspects of documentation severity in different projects regarding to their size. Some documentation samples are also reviewed. As the author of the work is maintaining and developing these projects, some conclusions are made regarding maintenance work performance with and without technical documentation and also return of investment on documentation creation.