Examples of good user documentation for a Joomla! extension
Hi everyone,
I'm part of the Joom!Fish project and planning on improving the user documentation. That's really needed IMO.
So to prevent myself from reinventing the wheel I'm asking you to list websites/extensions who have excellent user documentation. This way I can learn from it and the users will end up with 'good' documentation hopefully.
We also can discuss what makes up good user documentation, and what causes less good user documentation.
Feel free to list and discuss other resources on writing/recording user documentation. I hope we all benefit from this and end up with lots of good documented Joomla! extensions.
I'm part of the Joom!Fish project and planning on improving the user documentation. That's really needed IMO.
So to prevent myself from reinventing the wheel I'm asking you to list websites/extensions who have excellent user documentation. This way I can learn from it and the users will end up with 'good' documentation hopefully.
We also can discuss what makes up good user documentation, and what causes less good user documentation.
Feel free to list and discuss other resources on writing/recording user documentation. I hope we all benefit from this and end up with lots of good documented Joomla! extensions.
Views: 74
Replies to This Discussion
-
Permalink Reply by Peter van Westen (NoNumber) on -
I think the reason this discussion is so quiet is because there isn't much high quality documentation out there and we all (as developers) have the same questions you have.
Documentation for my extensions is high on my todo list too. But it seems to just stay there in the list :(
A problem I face too is that my extensions change a little with every release... features added and stuff like that.
And I already get tired of thinking about having to update the documentation too... -
-
Permalink Reply by Carolien on -
I think Joomlapack has quite good documentation. It has a real user manual with updates etc.
-
-
Permalink Reply by Bo Astrup on -
Actually I think Virtue Mart has a great online manual - but still with some major flaws. EG in section 4.6.6 it tells you:
"To add a new file, let's say an .mp3 file which is the file we want to sell, we just open the file form by clicking the "New" button in the toolbar of the file list"
But does not tell you how to get there. There is a new button on the page, but that will make a new product.
Else a nice manual, both online and pdf version. -
© 2012 Created by Amy Stephen.
