[Freeciv-Dev] Re: Documentation, Usability and Development

[Andrew Sutton <ansutton@xxxxxxx>]

On Wednesday 28 November 2001 03:14 am, Raimar Falke wrote:
>
> I agree with most of the stuff about.
>

i wonder if it wouldn't be possible to provide some kind of 
feature/requirement/design tracking for freeciv. it doesn't need to be 
complicated and it doesn't need to be overly thorough.

the feature list could be a simple document that describes the features of 
the current release. it would need to be sectionalized to discuss features of 
each game component. general architecture, server, client, modularity, etc.

requirements would take each feature and break it down into exactly what is 
required by the game: take the following feature/requirement example.

feature: Freeciv supports an unlimited number of nations for players to 
choose from.

requirement(s): The software shall provide the capability to allow an 
unlimited number of nations for user and computer play.

the design could just be internal document that can be extracted with tools 
like doxygen - which is, incidentally, how my company has started doing low 
level design documentation for big projects.

and actually, this is a good question. since there's a coding standard update 
going around, why isn't the possibility of using external document generators 
included?

just thoughts.

> IMHO if you want to change freeciv to use C++ that open another
> project. Because I think that C is a basic for freeciv and should be
> mentioned in your list above.
>

don't have to use C++. it's just my favorite. does that make me a deviant ;)

andy