I actually don't mind doing documentation for my modules, although it sometimes takes almost as long to do the docs as it did to code the module.
The bit I find the hardest is trying to *explain* how to use them (The bit where you document a particular method and its parameters is easy) - ie. making a tutorial that doesn't waffle on too much while at the same time providing enough information to help the user learn how to use the module.
This is my latest attempt : http://code.google.com/p/maxmods/wiki/MaxUnitModule
Is there anything that I shouldn't be doing there? Have I explained enough about what to do?
If you were to go through it, would you be able to sit down and use the module without too much trouble?
Any guidance is appreciated :-)
The bit I find the hardest is trying to *explain* how to use them (The bit where you document a particular method and its parameters is easy) - ie. making a tutorial that doesn't waffle on too much while at the same time providing enough information to help the user learn how to use the module.
This is my latest attempt : http://code.google.com/p/maxmods/wiki/MaxUnitModule
Is there anything that I shouldn't be doing there? Have I explained enough about what to do?
If you were to go through it, would you be able to sit down and use the module without too much trouble?
Any guidance is appreciated :-)