Easing the Volunteer Crunch

Locked
kismert
Joomla! Intern
Joomla! Intern
Posts: 73
Joined: Thu Jul 27, 2006 12:16 am

Easing the Volunteer Crunch

Post by kismert » Wed Aug 02, 2006 3:14 pm

Suggestion: could the on-line Joomla! documentation borrow the excellent idea of User-Contributed Notes from the PHP on-line manual? This would:
  • Allow people to easily contribute a useful point or tip. This could be a good way to gather that elusive troubleshooting material.
  • Reduce the amount of searching needed when the official documentation is inadequate.
  • Let many eyes scan for corrections and missing information. Notes could be combed periodically by the documentation team, and be selectively incorporated into the official docs. Submitters of incorporated notes would receive credit as a documentation contributor!
This micro-volunteer approach would lower the perceived barrier to contributing to the documentation. Busy people who are reluctant to over-commit can still contribute an idea that is important to them, while it is fresh in their mind.

-Ken
Last edited by kismert on Wed Aug 02, 2006 3:25 pm, edited 1 time in total.

User avatar
eyezberg
Joomla! Hero
Joomla! Hero
Posts: 2860
Joined: Thu Aug 25, 2005 5:48 pm
Location: Geneva mostly
Contact:

Re: Easing the Volunteer Crunch

Post by eyezberg » Wed Aug 02, 2006 4:08 pm

Great idea. Set up Help as the wiki pages with comments open to regged members (moderated)
Sometimes one pays most for the things one gets for nothing.
The important thing is not to stop questioning. Curiosity has its own reason for existing. AE
http://joomla15.[URL banned].com for J! 1.5 screenshots
http://www.eyezberg.com

kismert
Joomla! Intern
Joomla! Intern
Posts: 73
Joined: Thu Jul 27, 2006 12:16 am

Re: Easing the Volunteer Crunch

Post by kismert » Wed Aug 02, 2006 10:51 pm

Sounds perfect.

User avatar
Michelle Bisson
Joomla! Ace
Joomla! Ace
Posts: 1808
Joined: Fri Aug 12, 2005 12:47 am
Location: Quebec City, Canada
Contact:

Re: Easing the Volunteer Crunch

Post by Michelle Bisson » Thu Aug 03, 2006 3:20 am

Thank you for your suggestions!
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member

User avatar
visionspin
Joomla! Enthusiast
Joomla! Enthusiast
Posts: 183
Joined: Mon Aug 22, 2005 9:35 pm
Location: Pittsburgh, PA
Contact:

Re: Easing the Volunteer Crunch

Post by visionspin » Mon Aug 14, 2006 10:25 pm

Yes, we definitely need to do something to lower the intimidation factor of such a huge amount of work with just a few people to do it. I recommend that people contributing to it be able to reference the Editorial Style Guide as well, to keep us all on the same terms, etc.

User avatar
eyezberg
Joomla! Hero
Joomla! Hero
Posts: 2860
Joined: Thu Aug 25, 2005 5:48 pm
Location: Geneva mostly
Contact:

Re: Easing the Volunteer Crunch

Post by eyezberg » Thu Sep 14, 2006 11:39 am

A month later..? any chance you want some help there? ;)
Sometimes one pays most for the things one gets for nothing.
The important thing is not to stop questioning. Curiosity has its own reason for existing. AE
http://joomla15.[URL banned].com for J! 1.5 screenshots
http://www.eyezberg.com

User avatar
ianmac
Joomla! Virtuoso
Joomla! Virtuoso
Posts: 4785
Joined: Sat Sep 24, 2005 11:01 pm
Location: Toronto, Canada

Re: Easing the Volunteer Crunch

Post by ianmac » Fri Sep 15, 2006 3:21 pm

Has anybody followed up Joe on this?  He's been around Joomla! for a while...  there has to be something that we can get him to write?

Ian

kismert
Joomla! Intern
Joomla! Intern
Posts: 73
Joined: Thu Jul 27, 2006 12:16 am

Re: Easing the Volunteer Crunch

Post by kismert » Fri Sep 15, 2006 3:43 pm

All,

I believe I have found the code php.net uses to power it's official manual:

phpdoc: http://www.theprojects.org/php/phpdoc.php

I don't have enough PHP experience to evaluate it properly, but some of you PHP gurus out there could easily make a quick judgement on the practicality of using this for official Joomla docs.

-Ken

User avatar
Michelle Bisson
Joomla! Ace
Joomla! Ace
Posts: 1808
Joined: Fri Aug 12, 2005 12:47 am
Location: Quebec City, Canada
Contact:

Re: Easing the Volunteer Crunch

Post by Michelle Bisson » Mon Sep 18, 2006 11:29 pm

Joe,

I have sent you a pm.
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member

User avatar
Michelle Bisson
Joomla! Ace
Joomla! Ace
Posts: 1808
Joined: Fri Aug 12, 2005 12:47 am
Location: Quebec City, Canada
Contact:

Re: Easing the Volunteer Crunch

Post by Michelle Bisson » Mon Sep 18, 2006 11:31 pm

Ken,

Are you available to help us on the doc team?
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member

kismert
Joomla! Intern
Joomla! Intern
Posts: 73
Joined: Thu Jul 27, 2006 12:16 am

Re: Easing the Volunteer Crunch

Post by kismert » Tue Sep 19, 2006 12:40 am

Michelle,

Yes, I am available on a limited basis  :). I did let visionspin know this a while back. Let me know when you next meeting is.

-Ken

User avatar
Michelle Bisson
Joomla! Ace
Joomla! Ace
Posts: 1808
Joined: Fri Aug 12, 2005 12:47 am
Location: Quebec City, Canada
Contact:

Re: Easing the Volunteer Crunch

Post by Michelle Bisson » Wed Sep 20, 2006 2:47 am

kismert,

Keep an eye on this forum.  I will soon be telling how people can get involved in the doc project without committing to it. We are restructing to simplify the process of contributing.

In the meantime take time to download 1.5 and try it out as we will need people who are familiar with this version.

Thanks!
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member

User avatar
eyezberg
Joomla! Hero
Joomla! Hero
Posts: 2860
Joined: Thu Aug 25, 2005 5:48 pm
Location: Geneva mostly
Contact:

Re: Easing the Volunteer Crunch

Post by eyezberg » Fri Sep 22, 2006 7:15 pm

Sorry Miichelle, had turned off notification for PMs
I can start on some screens as I test SVN, anything more urgent than others?
Sometimes one pays most for the things one gets for nothing.
The important thing is not to stop questioning. Curiosity has its own reason for existing. AE
http://joomla15.[URL banned].com for J! 1.5 screenshots
http://www.eyezberg.com

User avatar
Michelle Bisson
Joomla! Ace
Joomla! Ace
Posts: 1808
Joined: Fri Aug 12, 2005 12:47 am
Location: Quebec City, Canada
Contact:

Re: Easing the Volunteer Crunch

Post by Michelle Bisson » Wed Oct 04, 2006 4:12 am

We are currently setting up the structure so that we can recieve contributions from community members without joining the doc team.

In the meantime, what is very important is for those who wish to help to get familiar with 1.5 and it's new features as that is what we will be focusing on.
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member

User avatar
Michelle Bisson
Joomla! Ace
Joomla! Ace
Posts: 1808
Joined: Fri Aug 12, 2005 12:47 am
Location: Quebec City, Canada
Contact:

Re: Easing the Volunteer Crunch

Post by Michelle Bisson » Mon Oct 09, 2006 9:22 am

All those who have volunteered to contribute to the User Documentation Project, please read :

How you can contribute to the Documentation Project?

http://forum.joomla.org/index.php/topic,102299.0.html

Thank you!
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member

User avatar
CirTap
Joomla! Explorer
Joomla! Explorer
Posts: 418
Joined: Mon Dec 12, 2005 5:34 pm

Re: Easing the Volunteer Crunch

Post by CirTap » Wed Oct 18, 2006 6:19 pm

kismert wrote: I believe I have found the code php.net uses to power it's official manual:

phpdoc: http://www.theprojects.org/php/phpdoc.php
The PHP manual is based on and built from XML files, or SGML to be correct. The module you found is not the one used for the user comments but for creating the various output formats from the "Docbook" xml files: http://www.php.net/manual/about.generate.php

CirTap
You can have programs written fast, well, and cheap, but you only get to pick 2 ...

"I love deadlines. I like the whooshing sound they make as they fly by." Douglas Adams


Locked

Return to “1.5 Archive”