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

[Petr Baudis <pasky@xxxxxxxxxxx>]

Dear diary, on Tue, Dec 04, 2001 at 04:46:49PM CET, I got a letter,
where Andrew Sutton <ansutton@xxxxxxx> told me, that...
> On Tuesday 04 December 2001 07:50 am, Reinier Post wrote:
> > 3 Where to put the documentation?
> >   1a in a dedicated corner on www.freeciv.org
> >   1b sourceforge/etc
> 
> i'd put it on freeciv.org. i think you can link to it from the sf docs 
> section. it would be nicer on freeciv. if you're talking about things like 
> the user manual, then i'd just include that as a separate product with the 
> freeciv project. that would let you get a) the program or b) the user manual 
> or c) the strategy guide - if one ever exists.
it does.
> 
> > 4 What does the documentation look like?
> >   Which tools to use to maintain it?
> 
> good question. i'm assuming you're talking about internals documentation. i'd 
> suggest html. its pretty much universal. as for an editing tool... hmm... 
> kword's okay. i don't know about abiword. ms word is really nice. whatever 
> medium needs to include support for embedded images (diagrams, etc) in case 
> somebody (like me) decides to break out UML for some of the design issues.
ah so! i don't think something ever have beaten ASCII+vim ;p.

-- 

                                Petr "Pasky" Baudis

UN*X programmer, UN*X administrator, hobbies = IPv6, IRC, FreeCiv hacking
.
  "A common mistake that people make, when trying to design
   something completely foolproof is to underestimate the
   ingenuity of complete fools."
     -- Douglas Adams in Mostly Harmless
.
Public PGP key, geekcode and stuff: http://pasky.ji.cz/~pasky/