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

On 13/05/2010 12:27, Israel Saeta Pérez wrote:
> I've been updating our current documentation for Plone 4, and I can
> swear that most changes (apart from the Upgrade Guide) have involved
> just a paragraph or two, where "from Plone 4" has been indicated as
> clearly as possible. The exception has been the User Manual, where we
> have replaced all screenshots by new Sunburst ones.
>
>    
It's been a similar case for the theme reference, and as there are many 
bits of the theme reference still to do (with potentially many people 
still working on Plone 3) I'd be really uncomfortable about branching it 
right now.
> IIRC Anne Botwell suggested time ago to create Kupu styles to
> differentiate stuff targeted to specific versions of Plone in a clear,
> consistent way along our documentation. Also, we can work to tag docs
> with the correct version(s) they apply to, and try to improve the way
> this info is presented to the user, so it's always clear to him/her.
>    
Yes, please, this is a nice discrete project that someone with design 
skills could take on - any volunteers?
> And, most importantly, *work on actually improving and updating the
> documentation*. All this discussion of branching docs for major versions
> and all doesn't make any sense at all if we don't get the docs written.
> Let's get more work done and discuss less.
>
>    
I agree. I've been talking to Israel about the possibility of defining 
smaller tasks to undertake in the theme reference manual - if anyone 
would like to lend a hand. With the current situation in my day job its 
getting harder and harder for me to give up time for documentation work 
and I'd really like to make it easy for someone else to pick up the work 
on it.

Anne

------------------------------------------------------------------------------

_______________________________________________
Plone-docs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/plone-docs

begin:vcard
fn:Anne Bowtell
n:Bowtell;Anne
email;internet:[email protected]
tel;work:+44 (0)1865 882829
x-mozilla-html:FALSE
version:2.1
end:vcard