Dizkus

I'm going to start a new module soon and I have decided to go ahead and document the process as I go along to serve as a module walkthrough. I'm debating on the format, however. I'd like whatever format I use to be:

portable (e.g. can be downloaded and viewed offline or posted someplace else)

commentable so others can give feedback on whether they agree or disagree with my methods or suggest how they accomplish things, whether or not they're compliant with the API, etc

easily accessible

The choices as I see them are:

HTML pages - easy to create and publish somewhere, but don't easily provide for commenting

News posts - could get me HTML content and comments, but where should they be posted? My site, mods.postnuke.com? Also, I don't know if these could be easily archived.

Forum posts - similar to news posts with same issues: where? can they be archived? etc.

Wiki - a Wiki might be nice, but again, where?

I'd appreciate thoughts from the other developers (since they're feedback and comments on the module would be welcome) and those that would like to use a walk through.

I think that I'm leaning towards forum posts, and probably posting them in this forum.

Thanks.

Throw in another one - Docbook XML?

--
Regards,
Simon

itbegins.co.uk - Zikula Consulting

Please read the Support Guide

If you do htmlpages, can you not add EZComments to it? Or with the sections option?

You might also consider doing several formats--a downloadable PDF, without the comments, and then an online one that people can comment on. I think having it on your own site would be fine.

This is something that is really needed! I've been wanting to do it for a while, but just haven't had the time. Good luck!