[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Poll ideas?



On Sun, 25 Jun 2000, Erik wrote:

>beat on 'em with a stick enough, and they'll start producing documentation.
>These people have ideas, and enthusiasm, they just don't realize the importance
>of very strong documentation and communication. Were someone experienced to
>take one of these idea spitting kids under their wing and kinda give them
>shoves in the right direction, they may flourish as designers. Since most
>programmers willing to take on a larger scale project have experience iwth the
>documentation, the programmer can assume this mentor role and kick the kid in
>the arse. We have experienced programmers, we have enthusiastic kids. It's
>theoretically a simple process to create a good game designer. :) 

It's very hard to get programmers to write documentation. Really hard. The
more talented the guy the less docs he/she writes. :-) I like to create
docs, and as I get paid to do Java right now it is very easy to document
the classes/methods using Javadoc. It also makes it really easy (and fun)
to piss the other coders off with remarks as: "had you documented that
parameter a bit better we'd never have gotten that bug".

I try to document my pet projects too, and have succeeded to some extent
quite well (IMHO, of course). At least all classes should be documented,
as well as have a small overview of the library and a tutorial (I assume
we're creating a lib here). That does not take too much time.

---------------------+------------------------------------------------------
 Jan 'Chakie' Ekholm |    CS at Åbo Akademi University, Turku, Finland
    Linux Inside     | I'm the blue screen of death, no-one hears you scream


---------------------------------------------------------------------
To unsubscribe, e-mail: linuxgames-unsubscribe@sunsite.auc.dk
For additional commands, e-mail: linuxgames-help@sunsite.auc.dk