I suppose everyone's path with FlightGear is a little different;
mine involves trying to gather documentation (and pray for howto's) on
the joystick, then aircraft installation, and so on. Part of this
process involves hardware, though I wish it wouldn't. I imagine every
developer would rather write one piece of code, not two.
And I'm quite aware that some of the worst documenters make the best
programmers; I was a sysadmin for a long time. It's a fact of life. How
about this idea? (Feel free to thow stones if it's already been
suggested somewhere.)
Let's say today we re-write the joystick handling in some way. The
code's in one place, the manual, FAQ, and WIKI are in others. This is
the classic layout; probably since the start.
But what if every top-level module had a built-in documentation file
with it? When you're hot-n-heavy on a module, and the juices are
flowing, your head's never more ready to describe to the world what the
changes are. It's the WORST time to go document another module, for
example.
If these pieces could be retrieved at every compile, pulled from the
source and then assembled automagically into a manual each time, we'd
save time updating old manuals, we'd get better documentation and spend
less time doing it. I think the Perl guys do something similar, but it
need not be like that...a skeleton of a manual, with module-names in it
would suffice, no?
Thoughts?
--
-----------------------------------------------------------------------
Brian Fahrländer Christian, Conservative, and Technomad
Evansville, IN
ICQ: 5119262 AOL/Yahoo/GoogleTalk: WheelDweller
------------------------------------------------------------------------
------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now. http://p.sf.net/sfu/bobj-july
_______________________________________________
Flightgear-users mailing list
Flightgear-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/flightgear-users
