Re: What's the best plain Documentation format?


good chemistry is complicated, and a little bit messy -LW
	PerlMonks

Re: What's the best plain Documentation format?

by jplindstrom (Monsignor)

on May 26, 2003 at 19:22 UTC ( [id://260880]=note: print w/replies, xml )

Need Help??

in reply to What's the best plain Documentation format?

I like the Wiki format a lot. I'm used to MoinMoin, but I'm sure there are dialects that are more expressive or powerful.

On the other hand, POD has a lot going for it, expecially when it comes to flexibility and power.

On the third hand, POD is really not that simple to use or clear to read. "=over 4", come on!

Comment on Re: What's the best plain Documentation format?

Replies are listed 'Best First'.

Re: Re: What's the best plain Documentation format?
by lachoy (Parson) on May 26, 2003 at 20:42 UTC

I love wikis too, but you really run into a brick wall when it comes to outputting. IME they're really not appropriate if you're planning to print your documentation as a deliverable, or make it part of a larger effort. The flattened nature of wikis (everything linking to everything) also makes it difficult to print, which generally likes a hierarchical format (table of contents, etc.)

Chris
M-x auto-bs-mode

[reply]

In Section Meditations