[Top][All Lists]

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

Re: Documentation.

From: Yoshinori K. Okuji
Subject: Re: Documentation.
Date: Fri, 25 Jun 2004 00:03:53 +0200
User-agent: KMail/1.6.1

On Thursday 24 June 2004 19:10, Tomas Ebenlendr wrote:
> So here is the question: what format? (and what names?).

Use plain text. It's good enough for this purpose. If you need a more 
complex one, use texinfo. Texinfo is the standard documentation tool 
for GNU, and many GNU programmers are used to it.

Regardless of whatever tool you use, the most important thing in 
documentation is "not to make it out of dated". This is really 
difficult. Indeed, I gave up keeping information on internals of GRUB 
Legacy in the manual. Maintaining good documentation costs the same as 
maintaining good code. So, I'd recommend that you keep your 
documentation as simple as you can.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]