DOCUMENTATION OF SOFTWARE SOLUTIONS

Cilj rada je bio utvrditi važnost dokumentiranja softverskih rješenja i načina na koje se ono provodi putem iznošenja teorijske osnove i kratkog istraživanog slučaja koji služi kao opći primjer odabira specifičnog alata za dokumentiranje. Teorijska osnova sadrži tipove dokumentacije i kome je ona namijenjena uz standarde dokumentacije i životni ciklus dokumentiranja. Objašnjava važnost svih pojedinih faza dokumentiranja i razinu razumijevanja i kvalitete koja je potrebna za neometano razvijanje i održavanje projekta razvoja softverskih rješenja. Rad također sadrži opći prikaz obilježja alata Sphinx za dokumentiranje i razloge njegovog odabira u tvrtki Percona.The aim of the paper was to determine the importance of documenting software solutions and how it is implemented through the theoretical basis and the short-case case that serves as a general example of selecting a specific documenting tool. The theoretical basis contains the types of documentation and to which it is intended for the standard documentation and the life cycle of the documentation. Explains the importance of all stages of documenting and the level of understanding and quality required for the smooth development and maintenance of a software solution development project. The paper also provides a general overview of the features of the Sphinx tool for documenting and the reasons for its selection at Percona