Page 1 of 1

Documentation?

Posted: Tue Oct 31, 2006 11:35 pm
by caribguy
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?

Re: Documentation?

Posted: Tue Oct 31, 2006 11:42 pm
by Vimes
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.

Re: Documentation?

Posted: Wed Nov 01, 2006 6:07 pm
by TheSaint
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! ;)

Re: Documentation?

Posted: Wed Nov 08, 2006 1:59 pm
by webamoeba
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.