Mod and add-on documentation request

[Website Rob]

Wolfmont, your points are well taken also but it sounds like you are coming from a Corporate background where people are paid to do a job. That is not the situation when it comes to Open Source Software (OSS).

People often write modules or code not because they are supposed to or because it's their responsibility, but because they saw a need and felt they could fill it. That is how OSS works. Others usually then come along and build upon what someone else started. With OSS being freely created and freely available, one can either use it as is or make it better.

As you frequent the Forums and read more posts, you will see where many have problems installing Zen Cart itself let alone whatever module. That is what the Forum is for, to help where one can. You are not the first to write/complain about documentation, for modules or Zen Cart, and in time things will improve.

[Wolfmont]

Rob,

I can see that, and yes, I do come from a corporate background. But I also often wrote documentation and job aids for software when I wasn't asked to do so, simply because I knew people struggled with a particular area or areas.

I understand that people are writing these things mainly for free, though I just paid about $70 for a mod I needed, and sadly, the documentation there was not so great either.

I applaud the open-source way of doing things. I've been using open-source software and freeware for years. But it doesn't solve the problem to say that someone can write a complex mod that is difficult to install and set up, but without documentation, and sit back with a smile, thinking they have done a great thing. Yes, it's marvelous, a thing of beauty!

Now, how does it work?

If the developer is not willing or doesn't have the time, it would be great if some user who knows the installation and setup process would pay back into the system by writing documentation. I think the fellow who wrote the manual for ZC did yeoman work on a huge task, but it would be a much smaller and easier job for someone to take on a single mod and write detailed installation and setup instructions for it. Quite frankly, I'm not qualified to write one for any of the mods, but I would certainly appreciate anyone who did it.

[misty]

someone to take on a single mod and write detailed installation and setup instructions for it.

This does happen..i.e. Easy Populate mod and
http://www.zen-cart.com/wiki/index.php/Easy_Populate

However, paid mods should be supported by dev/s who created them and NOT forum volunteers....

[Wolfmont]

I think maybe I should just retire from this discussion. I guess my problem is, I feel that the development job simply is not complete without decent documentation, and I'm not going to change my mind.

If it's a really simple mod to install, then it shouldn't be hard to write the documentation for anyone who may need it. So why not do it?

If the mod is complex to install and set up, then it's absolutely vital that good documentation be written. It becomes a necessity at that point.

I'll stay out of this discussion from here on, as my viewpoint has been aired so fully that people are probably tired of seeing it. I just hope that the situation changes, because undocumented mods and add-ons weaken the whole system by being somewhat deceptive. By that I mean, if ZC claims to have thousands of wonderful mods, and the great majority of those mods have no documentation or nearly useless documentation, ZC's reputation and credibility as an expandable and flexible platform suffers IMO.