[APBeta] Documentation using a wiki

[Dan Kuchta]

Personally, I'm not a big fan of online documentation, wiki or otherwise.  If manuals are well written and well organized, they can add dramatically to the usability of the software.  By the same token, poorly written manuals can be miserable to wade through.  While I'm sure writing manuals is not your favorite task, you are actually quite good at it and in my opinion, your manual is better than most commercial software I've purchased.  In fact, it was one of the reasons I purchased AstroPlanner to begin with.

On the other hand, I can certainly understand that you have limited time and would rather spend it writing code instead of manuals.  A wiki can be an effective way of getting the information out there and letting the community help with the updates and additions.  What you tend to lose is that coherent, organized "train of thought" that runs through a well written manual like yours.

Just my 2 cents. :-)

-Dan


On Jun 20, 2010, at 12:33 PM, Paul Rodman wrote:

> I am thinking of creating a wiki (a la Wikipedia) for providing documentation for AstroPlanner V2* (in particular the "how to" stuff. The reference stuff will still be via embedded help). As a matter of interest, how many of you are 
> 
> a. Familiar with editing a wiki** (in this case it will probably be MediaWiki, as used by Wikipedia I believe)?
> and/or
> b. Would be interested in creating content for, or editing existing content of, such a wiki?
> 
> Apart from (possibly) speeding up the release process, it would allow continuing feedback. e.g. if someone needs to use AstroPlanner to predict variable star peaks and this is not in the wiki, it could be added.
> 
> I have also heard, but only in passing, that it is also possible to produce a PDF from a Wiki (for those who like printed manuals).
> 
> Paul R.
> 
> * Thanks to tester Marius Strom for the idea.
> ** I'm actually quite ignorant of these things. I spent yesterday afternoon installing wiki software and starting to figure out how it is edited, etc. Turns out to be quite easy.
> 
> _______________________________________________
> APBeta mailing list
> APBeta at lists.astroplanner.net
> http://lists.astroplanner.net/listinfo.cgi/apbeta-astroplanner.net


=========================================================
If you lined up all the lawyers in the world end to end, no one would care.