Dušek MartinAbstract. You can go to every target by a lot ways. This world is controlled by many software, information systems or technologies, which helping to do things more effective, faster and with better quality. Also when you write documentation for software product, you have to use innovative technologies and try to do it better. Biggest trend in writing documentation is using system for online documentation – Wiki. In this essay you can read something about this method, history, future, advantages, disadvantages and about my own opinion how we can find solutions for this disadvantages. How we can write documentation is only first step. We have to know, what we really need in this documentation. I think we have to write only what people really need, no more, no less.Kostolanský JurajAbstract. 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.Láni MarekAbstract. The problems associated with insufficient documentation have to be faced probably by 99% of programmers if not by all. The creation of documentation is not a difficult process of software development, but this process is generally not met with much likes. Even modern approaches to software development pay limited attention to it. Such an approach is also an agile development. Its motto says: "Working software over documentation" and its answer to the question of how much documentation is necessary is: "Just enough." However, examples from practice show that documentation is a very important part of a software project and there are instances where a working software can not exist without it. We also try to define how much documentation is "just enough" and we discuss the patterns of documentation related to agile development. These patterns are Fake documentation, Timestamps, Project dictionary, Electronic backup and Distinct activity. For each of these models there are provided examples under what circumstances is creating of a specific type of documentation favorable, and what problems will it help us to avoid. We also discuss the possible ways in which it could be improved and outline the pros and cons of each solution.Lekeň TomášAbstract. Documentation of all kinds is part of every software product. Regular user, who is not technically proficient, most coming in contact with user manuals. It should therefore be placed the highest demands on its readability and clarity. New forms of documentation, such as video tutorials, contribute greatly for clarity. That make it easy to perform using of selected features. The essay focuses on the issue of readability and simplicity of created documentation.Škoda MatejAbstract. With using agile methodologies of software development, quality of software documentation is low, often it has low priority and it is neglected. Developers consider it needless. Result of documentation is often unusable document. This essay speaks is about problems as low quality of documentation, forced creation of documentation or creation of documentation too late. It describes opinion of scrummasters to documentation creation at agile methods of software development and its importance for software projects. It describes process of documentation creation and tries to bring some solutions to those problems by using combination of agile and classic teams to software development. It also express to another concept used to documentation creation and it is automatic generating.
|