Documentation?

Here you can contact the editors of our Extensions site, as well as access infomation relating to this site.

Moderators: tydust, LorenzoG, timothy.stiffler

Forum rules
Forum Rules
READ ME <-- please read before posting, this means YOU.
Post Reply
caribguy
Joomla! Fledgling
Joomla! Fledgling
Posts: 1
Joined: Sun Oct 22, 2006 8:30 pm
Location: Canada

Documentation?

Post by caribguy » Tue Oct 31, 2006 11:35 pm

Kudos to all those developers out there creating and updating all this good code for Joomla extensions!

However I have to take issue with the lack of documentation - c'mon guys it's pretty slim.
I know for some of you, English is not your first language, but some extensions have almost nothing.
I downloaded one recently that had to be added to the Joomla menu, but there was nothing to tell you that was the final step.

No, I'm not going to just complain - I have been thinking about this and wonder if the dev's out there would be interested in a "documentationalist" (is that a new word?)
I have very good documentation skills, have been doing it most of my life. I think it's because my memory is so bad  :D

What do you think?
Is there a need for a documentation writer, or do we just assume everyone has enough knowledge to figure it out?
Every man dies, not every man really lives - Braveheart

User avatar
Vimes
Joomla! Engineer
Joomla! Engineer
Posts: 356
Joined: Fri Aug 19, 2005 12:14 am
Location: United Kingdom
Contact:

Re: Documentation?

Post by Vimes » Tue Oct 31, 2006 11:42 pm

Have you tried suggesting to the individual extension writers that you do some documentation for them? I'm sure they'd love you for it.

Pick an extension you like then email the extension developer offering your skills. I'm willing to bet they'd jump at the chance to have their code documented.
http://www.jomres.net A bookings comp for hotels
http://jcd-a.org J'nt Com' Dev's As'n
Life is not a journey to the grave with the intention of arriving safely in one pretty and well preserved piece, but to skid across the line broadside, thoroughly used up, worn out, leaking oil, yellng GERONIMO

User avatar
TheSaint
Joomla! Enthusiast
Joomla! Enthusiast
Posts: 231
Joined: Sat Aug 20, 2005 4:15 am
Location: California, USA
Contact:

Re: Documentation?

Post by TheSaint » Wed Nov 01, 2006 6:07 pm

If you're feeling brave I'm sure they wouldn't mind if you took screenshots or captured video and made tutorials. Some of it is language issues, others is just a lack of time. Vimes makes an excellent suggestion. Quite frankly, an author would be very rude if he turned down an offer to get a free volunteer. Some of the documentation is sparse, but you can help out too! ;)
[size=70] Paul
http://www.gamehostingreviews.com - In development
The only thing necessary for the triumph of evil is for good men to do nothing. - Edmund Burke

User avatar
webamoeba
Joomla! Apprentice
Joomla! Apprentice
Posts: 22
Joined: Fri Sep 16, 2005 9:13 am
Contact:

Re: Documentation?

Post by webamoeba » Wed Nov 08, 2006 1:59 pm

I was just thinking, maybe it would be a good idea to add a 'documentation' button to the JED?? I've certainly found after having problems with lack of documentation, that it did exist, I just couldn't find it :p lol.


Post Reply