Documentation Acceptance Process Proposal

Sivan Green sivan at piware.de
Tue Nov 16 13:24:15 UTC 2004


Hello dear world!

  The need for setting up some sort of doc team work scheme for 
accepting new wiki / offline docs has been felt for ages, so now let us 
start discuss a more formal plan. I had this in mind when starting up 
with the DocTeam for long ago, and some of it may already be apparent on 
http://www.ubuntulinux.org/wiki/DocumentationTeam .

Preliminaries for establishing a work accaptance process:

     *  Setting up a wiki page  for people to link to their newly 
submitted WikiPage / Document. We should device a format for submission 
which would allow          us to contact the person who contributed, the 
language he supports etc.
         Tis can be  devided to :
                       + FAQs
                       + Howtos
                       + Medium size pages / docs (tutorials)
                       + Large documents (guides)

    * Establish the documentation testing team:
          * Have a list of people who would be willing to test drive new 
docs , comment and be commited to do it :)
          * Have a list of people from core team who would be willing to 
also review, fix and test. (one or two).

    * Make sure our svn server is on and capable, to allow for 
submission of offline oriented or non wiki material for review and work.

 From the contributing person point of view, we should have maybe modify 
DocumentHowto to include some staged instructions for submitting:
(this is a first proposed draft):

  Okay, You've just completed your amazing howto, document or a carfully 
crafted world domination plan and want to have it public?  What to do 
next you might ask? Follow this to make you stuff matter:

    * Go to the /SubmittedPendingDocs wiki page, link your new page from 
there. If you made an HTML/DocBook or other format doc - then put it on 
the web somwehre, or upload it to the wiki so we can view it.
   * Post the mailing list with "subject: [PEND_REVIEW] <link to your 
new doc>".
   * be ready for some comments and discussion ;)


Lemme here your thoughts...


Sivan





More information about the ubuntu-doc mailing list