Skip to content

Documentation: the Bane of Every Consultant's Life!

Too often I have seen projects get swamped and sidetracked by the desire to produce the perfect documentation set. I recall one project where the attempt to produce the ‘perfect’ paper trail so completely consumed all available cycles that no working code was ever produced!

I wholeheartedly endorse the Agile Manifesto that says, in part: “…we have come to value…Working software over comprehensive documentation….”

Still there is often a need to produce quality documentation for one’s client.

Just as with software, I am happy to reuse good open-source material.

I have recently come across ReadySet http://readyset.tigris.org/:

ReadySET is an open source project to produce and maintain a library of reusable software engineering document templates.

I am sure that there are other similar document collections “out there”, but this set seems to be a good starting point.

Tags:

C, Java Enterprise Edition, JEE, J2EE, JBoss, Application Server, Glassfish, JavaServer Pages, JSP, Tag Libraries, Servlets, Enterprise Java Beans, EJB, Java Messaging Service JMS, BEA Weblogic, JBoss, Application Servers, Spring Framework, Groovy, Grails, Griffon, GPars, GAnt, Spock, Gradle, Seam, Open Source, Service Oriented Architectures, SOA, Java 2 Standard Edition, J2SE, Eclipse, Intellij, Oracle Service Bus, OSB