Prečo má zmysel udržiavať dokumentáciu?
Dokumentácia by mala predstavovať definíciu softvéru pre zákazníka. Malo by z nej vyplývať, ako je softvér postavený a ako sa správa. Mala by definovať význam údajov v systéme aj jeho správne používanie.
Na udržiavanie dokumentácie však myslí máloktorý dodávateľ. Hlavne pri menších webových projektoch, kde je cieľ dosiahnuť čo najnižšiu cenu a často ich dodáva jednotlivec, pre ktorého je projekt jednorázová záležitosť.
Keď ale takýto projekt naberie na rozmeroch vzniká obvykle veľmi zložitá situácia
- nie je presne jasné, ako sa má softvér správať
- nie je jasné, ako sa má používať
- znalosti o systéme má len jeden človek, takže je veľmi ťažké presunúť vývoj na niekoho iného
- nie je jednoduché začleniť do vývoja viac ľudí
- v prípade zastaralého softvéru je veľmi komplikované vykonať aktualizáciu, alebo refaktoring
- je náročné pripravovať zmeny a rozšírenia softvéru
- nie je možné rozlíšiť čo je reklamácia a čo nie
- a mnoho ďalších problémov
Hodnota dokumentácie
Hodnotu dokumentácie nevnímate nikdy na začiatku projektu. Vtedy je všetko jasné, všetko si pamätáte a všetko funguje. Prínos si začnete uvedomovať po dlhšom období, keď už do softvéru bolo zrealizovaných veľa zásahov a zmien. Pri živších softvéroch sa niektoré funkcie prerábajú aj 3-4 krát vzhľadom na zmeny potrieb. Je vtedy veľmi užitočné mať po ruke informácie o funkcionalite softvéru. Rovnako v prípade nových ľudí pracujúcich na projekte, ktorí sa môžu s funkčnosťou softvéru detailne oboznámiť.
Samozrejme tvorba a udržiavanie dokumentácie si vyžaduje svoj čas navyše. Z našej skúsenosti je to obvykle okolo 5% navýšenie nákladov na vývoj. Vieme ale povedať, že je to veľmi dobre investovaných 5%.
Čo ponúkame?
Za účelom tvorby dokumentácie máme spracovaný vlastný modul - SoDocu (Software Documentor), ktorý je prevádzkovaný a udržiavaný na našej strane. Je priamo prepojený s modulom DirecS, ktorý je určený pre zadávanie požiadaviek na zmeny softvéru a technickú podporu (viac o DirecS).
Vždy po nasadení aktualizácie Vášho softvéru realizujeme zmeny v dokumentácií a zasielame novú verziu. Rovnako sa automaticky vygeneruje zoznam zmien v dokumentácií pre každú riešenú požiadavku v module DirecS. Takto udržiavanie dokumentácie považujeme za štandard pri vývoji softvéru na mieru.
