Well, after a couple of days of tinkering with CMSMS and its addons and mods, I have to say that most of the things you can and need to do is quite easy, but when it comes to the deeper and darker parts of the addons, you'll be referred to the forum and developmentspeed is next to nothing...
So my suggestion here is to implement an offline wiki, which can update from the website, as the faq/cmsms documentation when you're developing on a local webserver. This documentation could (should...) include the documentation supplied with the modules and updated with extra information, code and examples when available.
Reason? When I'm on the road and not close to an internet connection, I sometimes am in need of documentation... when its not there, it can get kinda frustrating to be able to nothing!
Also, besides being implemented offline, module documentation should be available in the online wiki as well! This would enable users and developpers with experience to add their snippets and/or complete overhauls of some module functions!
Offline wiki function including addons/mods documentation
-
Duketown
Re: Offline wiki function including addons/mods documentation
Do you mean something like you can find via the following:
http://wiki.cmsmadesimple.org/index.php/User_Handbook/Admin_Panel/Extensions/Modules/Cataloger?
In my opinion that would make sense, since everyone would be able to have the manual in a central location and maybe more important in the manual also a matrix can be set up that holds information wether the module runs agains a specific core version or not. In this way a developer could state in the top of the project (in the small description) that the manual contains last updated information. Since it is a wiki thing, users running a different version could add there findings.
http://wiki.cmsmadesimple.org/index.php/User_Handbook/Admin_Panel/Extensions/Modules/Cataloger?
In my opinion that would make sense, since everyone would be able to have the manual in a central location and maybe more important in the manual also a matrix can be set up that holds information wether the module runs agains a specific core version or not. In this way a developer could state in the top of the project (in the small description) that the manual contains last updated information. Since it is a wiki thing, users running a different version could add there findings.
