Basic rules for extension documentation needed
Posted: Wed Dec 05, 2007 8:15 pm
It is great that programmers release all sorts of excellent addons for Joomla just to make life easier for the rest of us who don't do programing. However, I would like to suggest some simple basic ways of making life even easier!
Please, when releasing an extension, there should be at least some basic instructions as follows:
1. Pre-requisites - Joomla version, any php settings etc
2. Installation guide
3. Configuration guide - most important of all - what to do with the extension once installed, how to use it, how to tweak it.
Some modules are difficult ot understand for some of us - for example I tested a recent floating module program where I was supposed to create a new position and then "point" the module at the new postion etc etc. So what does all that mean to a novice? Nothing. A few basic screenshots would be very helpful.
4. Basic troubleshooting - describing possible problems
For some reason extension creators hate documentation in plain English
IN the real world no program would be released to the public if it did not have basic documentaion as described. I know it's the last step but it would really help if you could provide some help! Thanks.
Please, when releasing an extension, there should be at least some basic instructions as follows:
1. Pre-requisites - Joomla version, any php settings etc
2. Installation guide
3. Configuration guide - most important of all - what to do with the extension once installed, how to use it, how to tweak it.
Some modules are difficult ot understand for some of us - for example I tested a recent floating module program where I was supposed to create a new position and then "point" the module at the new postion etc etc. So what does all that mean to a novice? Nothing. A few basic screenshots would be very helpful.
4. Basic troubleshooting - describing possible problems
For some reason extension creators hate documentation in plain English
IN the real world no program would be released to the public if it did not have basic documentaion as described. I know it's the last step but it would really help if you could provide some help! Thanks.