Kostolanský Juraj

Abstract. Technical documentation, user's guide, source code comments. These documents are considered an essential part of a software product. However, writers often spent much less energy to create them than they deserve. Although good documentation implies more satisfied customers, saved significant time and money, it is still considered as a necessary evil more than as a way to simplify own work and to improve the quality of the final product. In this essay I focus on the need for documenting software from multiple perspectives, I think about the concept of quality in the context of documenting and I describe the basic mistakes made by the documentation writers.

Out-of-date documentation is useful, too

Ogurčák Filip

Abstract. Technical documentation is an essential but often ignored part of the final software product. Ignored in the sense, that attention is given mainly to the functionality of the final product and for regular updates of documentation no time remains. Documentation, however, is not only for final customer, but is also important for programmers, development team leaders and company management. In this essay I would like to focus on the fact, that out-of-date documentation has still enough additional value for customer, programmer and manager controlling the progress of the project. In this case is important developed product as a whole, connection between modules and representation of general functionality. Finally is showed an absence of a standard, which would make technical documentation unified and simplified.