: Agile Development : Wednesday : Testing and Documentation : Wednesday Afternoon Tutorials (13:30 - 17:00)
DocIt!: Agile Documentation of Object-oriented Frameworks
Royal Palm Salon 3
Wednesday, 13:30, half day
Ademar Aguiar, Faculdade de Engenharia da Universidade do Porto (FEUP)
Tutorial number: 41
OO frameworks are a powerful technique for large-scale reuse, but they are particularly hard to understand by new users, especially if not accompanied with good documentation, which is typically hard, costly and tiresome to produce without appropriate tools and methods.
This tutorial introduces and lets you practice DocIt!, a simple and economical agile approach to produce lean and mean framework documentation, easy-to-adopt even in development environments restrictive to documentation activities.
DocIt! comprises a model, an agile process and a set of open tools capable of preserving the semantic consistency between source code, models, and textual contents, all integrated in a Wiki engine and Eclipse.
The tutorial drives you to get-started-fast using DocIt! and to learn-by-doing, by helping you on: meeting the needs of different audiences; cooperatively writing typical framework documents, namely overviews, examples, cookbooks, recipes, and pattern instantiations; combining and linking different kinds of contents; and organizing the contents as a minimalist instruction manual, easier to understand and use.
You are invited to bring your laptop and your own framework, or to pair with someone who does, or to document the popular JUnit framework.
Intermediate: Anyone engaged with framework-based software development.
Ademar Aguiar, Faculdade de Engenharia da Universidade do Porto (FEUP): Ademar Aguiar teaches at Faculty of Engineering, University of Porto (FEUP) and does Research & Development at INESC Porto, since 1989. He has specialized in the area of software engineering, mainly OO, UML, software architecture, OO frameworks, design patterns, agile processes, and software documentation, topics about which he has authored several research papers and presented many different courses to academic and industrial audiences. His PhD thesis, titled "A Minimalist Approach to Framework Documentation", proposes a pragmatic approach to document frameworks, which comprises a documentation model, an agile documentation process, and a set of collaborative documentation tools and utilities based on the Wiki concept and XML technologies. Currently, his main line of research is on Wiki-based tools to support the low-cost production of high-quality documentation for OO frameworks.