Title :
Creating and maintaining tutorials with DEFT
Author_Institution :
Dept. of Comput. Sci., Tech. Univ. Dresden, Dresden
Abstract :
Good documentation is crucial for frameworks to be used correctly. One important kind of framework documentation are tutorials. They tell how to use the framework and provide additional code examples. However, tutorials are rare compared to other kinds of documentation such as API documentation due to high creation and maintenance costs. In this paper we highlight the problems of writing and maintaining tutorials. Then we present the development environment for tutorials (DEFT), which provides support to address the identified problems.
Keywords :
application program interfaces; computer aided instruction; teaching; API documentation; development environment for tutorials; framework documentation; tutorials; Computer science; Contracts; Costs; Documentation; HTML; Project management; Software libraries; Switches; Tutorial; Writing;
Conference_Titel :
Program Comprehension, 2009. ICPC '09. IEEE 17th International Conference on
Conference_Location :
Vancouver, BC
Print_ISBN :
978-1-4244-3998-0
Electronic_ISBN :
1092-8138
DOI :
10.1109/ICPC.2009.5090072