Re: A project we can learn from

JoAnna Springsteen <[email protected]>
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
> some great stuff in there.
>
> I especially like
>
> "While it’s true that books shine in the “topical guide” area, they’re not
> really a great substitute for guides as part of the official documentation.
> Official docs, even when done poorly, are usually much more up-to-date;
> books, even when done well, are often out of date the day they hit the
> shelves"

That's exactly my issue with books. May gain us visibility but they're
too hard to keep current.


> and the fact that you WILL need all three kinds of documentation

Yup. when I see a document that addresses all audiences and all of
their needs, I will be impressed.


> With regard to the developer manual, whats the procedure for ripping out
> topical overviews like those of Martins and putting them into an aggregated
> manual that will be maintained by everyone? Is it just a matter of asking
> the authors permission?

That is entirely up to the Editor of the development section and the
individual authors. All of our docs are copyrighted by default (don't
know what happened to the push for CC stuff on our docs), but I doubt
any author will protest.
Israel probably already has some ideas for the developer manual on
plone.org - we have bits and pieces that nee to be consolidated. But
it's not the same as Mikko's manual as none of it is auto-generated.

While I know this is important, it's kind of on the back burner.
Getting that Knowledge Base up and running is priority number one
right now. After that we can discuss dividing up content (since most
of it will happen with the move anyway).

JoAnna

------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
trial. Simplify your report design, integration and deployment - and focus on 
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
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.