Documentation proposal

Brian J. Tarricone bjt23 at cornell.edu
Mon May 4 21:42:55 CEST 2009


Jérôme Guelfucci wrote:

> I think we should take into account who is going to write the 
> documentation: docbook may be 100% fine for developpers but it's really 
> unfriendly. During the 4.6 cycle I contributed to the xfdesktop 
> documentation and I can tell that docbook is really a pain for newcomers 
> and that it could deter some potential contributors.

Well, why do you think it's unfriendly?  Is it unfriendly because you 
had to learn new markup tags?  That's not unfriendly; that's just the 
normal learning curve for picking up a new tool.

If there's anything specific about docbook syntax that makes it 
particularly unfriendly, then sure.  But personally, I've just never had 
a problem with it.  I just keep a docbook reference URL nearby so I can 
look things up when I forget (same as I do when I'm writing HTML/CSS).

If you can point to another markup language that has similar features 
and doesn't have a learning curve (basically: something that "everyone" 
already knows), feel free to suggest it.

	-b




More information about the Xfce4-dev mailing list