Like any other product, service, or technology, an API needs to be usable, to succeed.
This principle applies as much to software design, as it does to every other kind of startup, and to keeping a business running, in general.
The end result of many years’ operation should be a big deal! The plans that show “how you get there from here” are the growth models for the different legs of the tetrahedron.
Using DreamWeaver templates, HTML generated from DITA sources can have its look and feel modified substantially — interactively, by a graphic designer by modifying CSS, along with the layout of “editable regions” and boilerplate. That styling does not need to be coded in the DITA toolkit, then, and does not need to be re-integrated into each subsequent release of the toolkit.
Why I chose the CDDL licensing model, when the project was hosted at Kenai.com.
A listing of operations that need to be carried by a system that wants to ensure reference integrity — so links remain valid as files and folders are moved or renamed.
A suite of utilities that converts HTML files into Linux man pages, where “man” is short for “manual”.
This is the CD that accompanied the book, for anyone who wants to access the programs it contains.
Here is a link to the JBB-CD.
- “Hello World” application
- Body Mass Index calculator
- Register your user name (a web applet)
- A WordCount application (count the number of words in a file)
- Othello program – plays the game of Othello
- Personal Project Scheduler – a tool that calculates time required for a hierarchy of project tasks, and predicts delivery dates based on the sequence in which tasks are undertaken.
Your technical writers are your first and best usability testers. In effect, they are the “canary in the coal mine”. If you let them, they’ll give you some of the best feedback you’ll ever get. And if you engage them early enough in the development process, they will give you great design suggestions, as well.