Category Archives: documentation

Caging Knowledge

Posted on January 21, 2012 by kingargyle

So, Apple’s recent iBooks 2 announcement has many drooling in the media.  While I applaud the attempt to make textbooks more affordable, I do not like the proprietary nature of the implementation.   Consumers are getting locked more and more … Continue reading →

Posted in documentation, standards | 1 Comment

Web Service Documentation using WSDLDocTool

Posted on July 29, 2011 by kingargyle

Update: March 3, 2013, the project in general is not being maintained any longer, however, I have a new branch called “develop” that contains a version that will build successfully from the command line. You may get that version from here: … Continue reading →

Posted in documentation, open source, turmeric, web services, wsdl | 10 Comments

>Generating JavaDoc with Maven 3 and Tycho

Posted on September 4, 2010 by kingargyle

>One of my pet peeves are projects that don’t provide some form of SDK information. Whether this be documentation on extension points or javadoc. This little peeve was irritated again when I was trying to find some information on some … Continue reading →

Posted in build, documentation, eclipse, maven, tycho, xml, xsl | 2 Comments

>Flexing the Vex editor

Posted on March 28, 2010 by kingargyle

>I’ve been doing more writing lately besides just blog posting. One of the problems I have with tools like Microsoft Office and Open Office is that it is very easy to mess up the presentation side of things. Especially when … Continue reading →

Posted in css, dita, docbook, documentation, eclipse, wiki, xml | 5 Comments

>Eclipse Documentation on the Wiki

Posted on November 2, 2009 by kingargyle

>A while ago Chris promoted the idea of single sourcing documentation from the wiki. I followed up by helping to write the Documentation Guidelines. Since then, there are a number of projects starting to use the wiki for their documentation. … Continue reading →

Posted in documentation, eclipse | Leave a comment

>Standards, Documentation, Single Sourcing, and Continuous Integration

Posted on September 15, 2009 by kingargyle

>Over the last several years I’ve had the pleasure of working with many standard organizations. Many are trying to improve their development processes to meet the membership and the communities needs sooner. However, almost all have one area that still … Continue reading →

Posted in agile, docbook, documentation, standards | Leave a comment

>Cramps on Single Sourcing with Wikis

Posted on August 27, 2009 by kingargyle

>I’ve been working on the eclipse Documentation Guidelines for Single Sourcing using the eclipse wiki. One of the things I’m discovering is that wikis are great at capturing unstructured information and styling: bold italics underline image code And for capturing … Continue reading →

Posted in documentation, eclipse, wiki, xml | 7 Comments

>Eclipse Documentation Guidelines

Posted on August 16, 2009 by kingargyle

> Documentation is the castor oil of programming. Managers think it is good for programmers, and programmers hate it! Jerry Weinberg, Psychology of Computer Programming Chris opened bug 283734 “Documentation Best Practices” to see if there is a way to … Continue reading →

Posted in documentation, eclipse | Leave a comment

>WikiText and DocBook almost valid/well-formed

Posted on August 15, 2009 by kingargyle

>If most of your information is going to be output into HTML and you like the default format that the Mylyn WikiText produces, then you do not need to read any further. However if you are a big fan of … Continue reading →

Posted in docbook, documentation, eclipse | 3 Comments

>Single Sourcing from a Wiki

Posted on August 11, 2009 by kingargyle

>There is a movement on in eclipse land to migrate to the Wiki for some of the end user documentation. I’ve been slowly moving the PsychoPath XPath 2.0 processor documentation over to the wiki as well. What I’ve found is … Continue reading →

Posted in docbook, documentation, eclipse | Leave a comment