blog documentation FAQ followers forum marketplace services youtube

Documentation Comments

The Jamroom Network » Forum » Suggestions » Page » Documentation Comments
jimmyk
jimmyk
@jimmy
12 years ago
514 posts
I was just looking at the Documentation section and I see for every feature / doc listed there's an ability to comment at the bottom. You might want to reconsider having comments turned on there. I can already see the first time developer creating 'pages' of comments trying to figure out a feature instead of using the forum for questions. I would turn those off and have a link to the support forum.

Just my 2 cents.
updated by @jimmy: 12/17/13 12:41:24PM
michael
@michael
12 years ago
7,768 posts
Interesting thought. I expected the comments to be used like:

You could add this in to make it better: "Proin arcu velit, gravida vel massa molestie, sollicitudin porta odio. Donec aliquam placerat est at adipiscing. Phasellus varius erat in est feugiat, in blandit augue sagittis. In scelerisque odio dui, ultricies consequat est vestibulum nec. "

Then delete the comment once it was in there. Too trusting?
updated by @michael: 05/29/14 10:16:47AM
jimmyk
jimmyk
@jimmy
12 years ago
514 posts
Sure, if you're going to moderate every comment there then having comments would be fine. Though, there are a lot of DOC pages to mod. I would just re-direct or have a link to the forum. The forum is where, I would think, you would want on-going discussions.

As you know, newbs are going to comment the crap out of that doc section. Especially when they're trying to learn something.
michael
@michael
12 years ago
7,768 posts
your right, I'll point any questions to the forum. I'm yet to see a comment on a doc though. I think the system emails me when that happens.

See if it gets too much to handle.
jimmyk
jimmyk
@jimmy
12 years ago
514 posts
I think it's going to be a little while before thing really get going with the new JR. Times have changed since the early days of JR. Everyone wants to just install Wordpress, Joomla, or Droopy.

Once people really re-discover JR and understand how it's better then you'll be getting more people using and commenting.

I think it's going to be much easier for you to manage questions from one central location... the forum. The DOCs section would be the only section where I would say: turn off the comments.
updated by @jimmy: 11/14/13 07:22:01PM
SteveX
SteveX
@ultrajam
12 years ago
2,584 posts
Comments on docs can work really well eg php.net

Not many people commented on the jr4 docs though.


--
¯\_(ツ)_/¯ Education, learning resources, TEL, AR/VR/MR, CC licensed content, panoramas, interactive narrative, sectional modules (like jrDocs), lunch at Uni of Bristol. Get in touch if you share my current interests or can suggest better :)
jimmyk
jimmyk
@jimmy
12 years ago
514 posts
I'll agree with you, php.net comments do work. In the end, it's up to you guys what you want to do.

I was looking over the docs last night... Wow, much better then the old docs. Not that the old docs were bad or anything, the new docs really explain things well.
michael
@michael
12 years ago
7,768 posts
Great comment, good to hear. :)

Tags