Ashkelon: Open-Source Documentation Management for Java

Are you overwhelmed by an explosion of Java APIs? Can't find that factory method to construct the class you need? Come learn about a tool that can simplify your job as a Java programmer. Ashkelon is an open-source tool that allows you to maintain all your javadocs in one central repository. Its user interface puts you in command of learning source code in ways that existing javadocs cannot support. Lookup a Class, Interface, or Method directly by name, by author, using wildcards, matching specific modifiers, or any combination thereof. Eitan Suez will speak about the origins of this tool, how it works, and how it can impact your productivity as a Java programmer.

Session Goals:
This session has two goals. The first is to introduce a documentation management system for Java that has the potential to become an integral part of a programming team's software development process. Such a tool serves as an aid in day-to-day programming, in learning new APIs, and in gaining insight into code. It can be used to increase the visibility of your code within a organization or community. The second goal is a side effect of the first: through a detailed review of the system's design and user interface, it exposes attendees to various elements of good user interface design and usability.

Prerequisites:
Basic understanding of the Java programming language. Experience with the javadoc tool (at the very least referencing javadocs, if not generating them). Basic understanding of a three (or more) tier web application.

Session Rating:
Intermediate

Category:
Core Java

About Eitan Suez

Eitan Suez is an independent software developer based in Austin, Texas. Some of the more visible work Eitan has done includes the open source project 'ashkelon' (sourceforge), a system for Java API documentation management; more recently, the open source framework JMatter (jmatter.org), a framework for constructing rich domain-driven workgroup applications (Java, Swing). Eitan has spoken at various NFJS events in years past, is active with his local JUG, and passionate about the practice of software development.

More About Eitan »