Jan 24
Gnome Documentation
I’ve recently become interested in donating some of my time on the weekends (as if I have it to spare) to working to documenting the applications that I think are great and would like to see their usership expand. I figured I’d start with helping out my current interest: pyTrainer.
So I read the Gnome Documentation Project handbook and decided how I was going to tackle this. First, I needed an editor and Conglomerate or Vex look like good options. From there I’ll create the appropriate DocBook articles to describe a single panel at a time. These editors look like they make DocBook editing a snap, so I’m hoping that a few hours this weekend, spent recovering from my 14-mile run, will be plenty to get sufficient level of effort accomplished.
I’ve never been overly interested in doing documentation, but these editors make it easy enough that I can focus on the documentation and not the document. This will allow me to raise issues on the mailing list as I document them in hopes that they will be corrected. In fact, I have looked at the format and I must say that I am rather impressed with DocBook. It’s like an XML version of HTML minus the crap.
No Comments
Leave a comment