LiveDocs really irk me, the docs themselves are ok, but the ability for users to leave comments at the bottom is really a good idea gone wrong.
I think the point of the comments should be to highlight an error or ommision.
People are asking general forum style questions here, and what's worse sometimes getting answers. Here's how it should work
User comments on error or ommision, someone (moderator) reviews, if not appropiate then removes comment. If appropiate, either leave the comment, or ideally modify the documenation online and get rid of the comment.
After all, when reading docs, I don't want to have to sift through comments checking that the docs are correct, I should see there is a comment, something is off or there are no comments, everything should be ok.
5 comments:
This assumes that users always know what the docs should say. What if the docs aren't clear or seem to be wrong but the user doesn't know what the correct text would be. Asking a question is a way to highlight the lack of clarity or error in the Live Docs and also elicit the required clarity or correction from another, more experienced, user.
I agree with you -- editors need a certain ruthlessness to keep the off-topic from consuming others' attention.
Hi, I'm the ColdFusion and Flex doc manager and the business owner for Adobe LiveDocs. Currently, we encourage comments/additions/errors in LiveDocs comments and discourage questions. While Mr. Lord is correct that questions can highlight unclear docs (and we've used this information in the past to decide what to work on), the Forums is (are?) still a better place to get your question answered.
In the future, we hope to provide a direct link from LiveDocs to the Forums, along with a list of relevant Forums threads displaying in the Comments area of the page.
HTH
Randy Nielsen
Flex and ColdFusion Documentation Manager
Oi, achei teu blog pelo google tá bem interessante gostei desse post. Quando der dá uma passada pelo meu blog, é sobre camisetas personalizadas, mostra passo a passo como criar uma camiseta personalizada bem maneira. Até mais.
Personally, what annoys me is how slow it is. it's not like there's a hude ammount of content. It does go a bit faster after the viewing app has loaded the first time, but honestly, I often go there with a specific page and don't go any further. But that's just eh.
Post a Comment