Message: previous - next
Month: March 2011

Trinity End-User Documentation

From: Darrell Anderson <humanreadable@...>
Date: Wed, 9 Mar 2011 10:42:14 -0800 (PST)
I have close to 3 decades technical writing experience. Naturally, I have an interest in any documentation packaged with Trinity. :)

The Help files need serious attention. In KDE 3.5.10 many Help files are out-of-date. Eventually we have to update those Help files.

I don't know how the original Help files were maintained or created. I need help and direction with that.

I want to see an overall user guide to Trinity. The guide would be available in two forms: HTML and PDF. The HTML version would be a desktop shortcut available to all users who first install Trinity and should be a menu option for those who delete the shortcut.

I am willing to lead this part of the project. I face an immediate challenge: my background is overwhelmingly with paper products and not electronic. I need help and advice with the tools I need to learn to produce two different outputs (HTML and PDF). OpenOffice Writer (now LibreOffice) might be a choice, but I suspect the HTML output will leave much to be desired. Some sort of structured authoring front-end would makes sense (DocBook?), but that means a lot of sweat equity to massage the back end formatting. The system used to produce the original Help files might be a solution.

I am open to ideas and discussion.