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

Alex Clark <[email protected]>
Newsgroups gmane.comp.web.zope.plone.documentation
Organization ACLARK.NET, LLC
Message-ID <[email protected]>
Hi all,

I'm sure this has come up before but I'm wondering if it could gain some traction now.
I've been lurking in #plone-framework and I really love the proces, and daily grind
of work and activity that goes on in there. I'm wondering if we could inject some of 
that enthusiasm and activity into the documentation project.

We have soooooooooo much good documentation out there, but very little structure
or organization AFAICT (and not due to lack of effort, I know people have
been working hard at various levels).

To that end, I propose we focus on the following:

0. Elect a "doc team leader" similar to the FWT leader, and have
   the Plone Foundation pay a small amount to them to encourage
   them to do a good job. It could even be the FWT leader, but
   I doubt Eric or Hanno want the additional responsibility.
   I nominate dukebody :-).

0.5. Elect a "doc team", again mirroring the FWT process here.

1. Identify all the resources we care about, e.g.:

    - FAQs    
    - Manuals 
        - Plone Core Developer Reference   
        - Developer Manual    
        - Plone 2.5 User Manual   
        - Plone 3 User Manual 
        - Plone 4 User Manual 
        - Plone Upgrade Guide
        - Add-on Products Developer Manual    
        - Plone Theme Reference   
        - PAS reference manual 
        - Fix for CMFEditions 
        - Zope Component Architecture Manual 
        - GenericSetup 
    - Error References    
    - Links   
    - Glossary    
    - Books   
    - Demonstration Movies    
    - Knowledge Base  

2. Identify a subset to version and release.

3. Work toward a release. Ideally one that corresponds to a
   software release, but I suppose that is not mandatory.

4. Have fun and profit.

5. Hang in #plone-docs 24/7.

Thoughts?

Alex

-- 
Alex Clark · http://aclark.net
Author of Plone 3.3 Site Administration · http://aclark.net/plone-site-admin


------------------------------------------------------------------------------
Download Intel&#174; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Plone-docs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/plone-docs
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.