Carnuke,

I have contacted jenclas yesterday, he will help me to create the documentation for the news module. And I agree with what I read in this thread, a help from someone else can be the difference between a doc and no doc.

Bye,
Hervé

he? I could have sworn Jen is a she...

Herko

So Jenclas, excue me humbly, my knowledge in terms of first name is limited to the french

Quote:

I never intended the wiki to hold the final document, just as a means of getting to that stage. My original post outlined that. All documentation would start from a template designed by the documentation team to show their standards and what they expect to see in module documentation... that is how I envisioned it. Not as a blank page.

Sure, the ideal situation is to have the developer write their own documents, but ideals won't get documents written, though help from others might.

Rowd, I take your point and I must be careful not to let the 'ideal become the enemy of the real' I will look at this again. Good, available documentation is better than excellent possible docs.

The SmartFAQ doc did take a long time, maybe unrealistic as a general standard?

So, we should look at the level of details again and come to a reachable solution.

A while ago, I also made a suggestion to use a docmentation primer, like a basic input form that a developer could submit to the documentation team.see here. (ignore the theme, this was just a sandbox idea)

It attempts to capture as many details as possible that can be interpreted into a simple, formal document. We cannot possibly document all existing modules to a high standard, but producing a form like this, with an invitation to developers of existing modules to 'upgrade' their documentation though it.

It's a half-way house between nothing at all and something useful.

Thanks for your comment.