Re: Proposal to manage documentation similar to (or along with) core software.

David Hostetler <[email protected]>
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
> unequivocally obvious what documentation you are reading (because
> of the URL of the documentation, e.g. /documentation/4.0. How
> much more clear can it get? ;-))

... or, rather, what documentation you *would* be reading, if it were
there.  It does no good to have a bunch of tidy version-specific URLs
if there isn't comprehensive documentation to go under them.

Just being a little devil's advocate here, but isn't this notion of
formally versioning the docs putting the cart a bit before the horse?

Or are you of the opinion that versioning is worthwhile even if the
docs continue to be piecemeal and prone to decay?


The highwater mark, in my opinion, is the documentation of python
itself.  I even keep local copies of the docs for 3 separate versions
(2.4*, 2.*, and 3.*).  But imagine that python wasn't documenting
itself well and the documentation for, say, a third of its modules
only existed in 2.4.   The value of any given version set is
proportional to its level of coverage.

Plopping people into a /documentation/4.0 folder is only compelling if
that's truly where they can get everything they need.  If they're
constantly bumping into gaping holes and dead ends, and have to keep
jumping around between the version silos, then it's hardly a
warm-fuzzy inducing experience, and its even arguably *worse* than
what we've got now -- which is essentially a LIFO queue for doc
topics.


regards,

-David

------------------------------------------------------------------------------
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.