2 replies [Last post]
hanoii's picture
Offline
Joined: 07/30/2008
Juice: 103
Was this information Helpful?

Working with ubercart over a few months I found documentation sometimes outdated, or incomplete, or hard to understand or with some errors. Now I am not a huge documentator of my own things so this is not a critic, but just wondering... is there any reason why documentation nodes don't accept comments? And going even further, why not have documentation open to be edited by anyone, kind of wikipedia? You could use revisions just to keep track of changes in case someone messes things up, but in the end, I think we are all going to benefit from that. Someone might stumble upon some and add considerable amount of useful information to the documentation.

Just thinking out loud... I generally go the core and see how things are done, but a nice piece of documentation is always welcomed.

Thanks,
a.=

Ryan's picture
Offline
Joined: 08/07/2007
Juice: 15438
Re: Documentation more community-like

The main reason docs are setup as is is because we haven't devoted the time to change it. There is a role for docs moderators, but we haven't really organized that. I'm happy to grant it to anyone who PMs me. The main reason it's not open to all is to hopefully cut down on the amount of moderation needed... but yeah, a lot of it is out of date anyways. Sticking out tongue

We don't have comments enabled b/c docs pages just aren't really there for discussion. I'd prefer a post in the Docs forum if something's horribly wrong or outdated. My opinions are subject to change, though. Laughing out loud

hanoii's picture
Offline
Joined: 07/30/2008
Juice: 103
Re: Re: Documentation more community-like

I don't mind having that doc moderation role. I can't promise anything but it would be good to have the opportunity to write something If I think it would help...

As for the comments, well, they're good to contribute to documentations pages without editing them, it seems to work OK for drupal.org doc pages, doesn't it?

And as for having the docs open for everyone, I kind of thought that it would be the whole community who would be moderating it, but just a few moments after my post I also thought that it might not work as documentation is most of us are lazy to do Smiling In anyway, is just something that might be good to consider, or even try selectively with some sections or doc pages.. but I can also see the downsides of it.