• newbies

last modified January 4, 2009 by jluvsu2

We need a standard process for getting new people started when they volunteer for the documentation team.

We also need to establish a way to mentor new people until they are comfortable contributing.

 

Formal Docs

Very obvious first step is to join the doc list and #plone-docs

All new people should start with reading our standards. Find them here

Contributers should become familiar with our new editing/review process. Find that here

Contributers should tell doc team what their skills, strengths, and interests are. 

Section editors then suggest documents that need to be written or edited based on the contributor's skills.*

Editor works closely with the contributor on her/his first document until it is published. 

 

* In order for this to work, editors must have a very solid idea of what docs are needed and who is currently working on what item. We should probably have a public list of docs we want written or docs that need edited. (should we put this in trac? somewhere else?)

Israel: +1 for Trac. We should consolidate a list of tags to use in the tickets, e.g. "newbie", "shorttask", "urgent"...

JLS: I was thinking more like topic oriented- "themes", "security" , "development", etc. so we can tell at a glance, even without an owner, which editor belongs to the task. It could also be easier for newbies to say ok I have skills on themes so I'll only look at these doc tickets with these keywords. No reason we can't have multiple keywords tho, right?


The doc team should have a page that outlines this process specifically so that when someone does email the doc list or ask in the channel, we can quickly send the person to the page so we can start the process.

 

 

Knowledge Base

Anyone with a plone.org ID will be allowed to contribute to the knowledge base.

Anyone with a plone.org ID will be allowed to make changes to documents they did not author in the knowledge base.

We suggest that authors follow our guidelines but it is not required to have a doc in the KB. If the doc is to one day move into the formal doc set, it will need to follow these guidelines.