Add notes + points

icefox · wrote on 28 Jun 2011, 16:35

When you log into the new docs site at the bottom of the page where the new note button would be if you don't have enough points it should say: "You need X points to Add a note, you can get points by [link]"

icefox · wrote on 28 Jun 2011, 16:56

hehe all the top of the alphabetically sorted classes are rated up already

icefox · wrote on 28 Jun 2011, 16:56

looks like other people are looking for points too

mgran · wrote on 28 Jun 2011, 18:00

Having fun Benjamin? :)

If you're looking for easy points you could just rate up good content as you see it around the site. Then again you're an old troll and could probably sort out some forum posts with real content ;)

I'm guessing you wanted the 180 points so you could post that doc note? I'll let the doc team know. However the best place to report that would have been here: http://bugreports.qt.nokia.com/browse/QTBUG/component/19132

Cheers!

icefox · wrote on 28 Jun 2011, 18:12

Hehe, yah talking on irc the idea of putting a link at the bottom of the page pointing to where to file bug reports against the documentation seemed a good solution. I didn't even know that the notes were not for doc bug reports until after I had grinded for 45 minutes to get 180 points.

mgran · wrote on 28 Jun 2011, 18:21

[quote author="icefox" date="1309284771"]I didn't even know that the notes were not for doc bug reports until after I had grinded for 45 minutes to get 180 points.[/quote]

Ah yes, the dos and don'ts of the doc notes are only visible as you want to add them. We shall do something about that.

Welcome to DevNet though! Did you attend the summit in Berlin two weeks ago? If so I can get you your first badge :)

icefox · wrote on 28 Jun 2011, 18:36

Sadly I couldn't go. I am encouraged to not participate in Qt and forbidden from contributing by RIM legal.

mgran · wrote on 28 Jun 2011, 21:04

Oh well, that is a showstopper for sure. Hopefully you're still allowed to wear washed out silly Qt t-shirts :)

PS. There is a link to your blog posts on Labs from http://labs.qt.nokia.com/author/bmeyer/ that is not working. We had a major rework of the Labs blog a while ago and the new link is http://labs.qt.nokia.com/author/bmeyer/. I made use of your gravatar.

icefox · wrote on 28 Jun 2011, 21:46

Yah, bit of a damper on Arora, but I can still muck around and make (some types of) apps that depend upon Qt. Thanks for pointing out the broken link I have updated it.

P.S. Really love the ability to comment on docs. Something I have been thinking of doing for years (making a site that loaded qt docs and let you comment on any function).

mgran · wrote on 28 Jun 2011, 22:02

[quote author="icefox" date="1309297611"]P.S. Really love the ability to comment on docs. Something I have been thinking of doing for years (making a site that loaded qt docs and let you comment on any function).[/quote]

Thanks! We have some corners to iron out but we're getting there. It's a great project to work on, people obviously care deeply for the Qt Documentation. We have given us the summer to make it a solid stable feature.

mlong · wrote on 28 Jun 2011, 22:18

Call me a fuddy-duddy, but I think it should be pointed out (former Troll or no) that blatantly spamming up a thread just to gain some fast points is really, really in poor taste and is not the kind of thing that should be encouraged or laughed off with a wink.

Just saying...

(On the other hand, 5 more points for me!)

mgran · wrote on 28 Jun 2011, 22:49

I'll purge the silliness when I'm back at work tomorrow, no worries mlong. Thanks for speaking up. I'm definitely a more accomplished fuddy-duddy when I'm at my desk.

Edit: done now

mlong · wrote on 28 Jun 2011, 22:55

It's ok. I feel better in general now having vented. :-D

ucomesdag · wrote on 29 Jun 2011, 01:54

Didn't get it at first, the spamming ex-troll :-)
But he made a point (180 to be precise) ;-)

icefox · wrote on 29 Jun 2011, 18:40

Having thought about it a bit more why should a documentation error not get noted on the page? Why get filed away on some other bug tracker where it might get fixed eventually when as a note on the page it can directly help those who are viewing said page?

giesbert · wrote on 29 Jun 2011, 18:43

I think it could be stated on both: JIRA and doc note, but JIRA is a must, doc not an option, right?

icefox · wrote on 29 Jun 2011, 18:47

... blatantly spamming up a thread just to gain some fast points is really, really in poor taste and is not the kind of thing that should be encouraged...

The problem is that is was directly encouraged. I wanted to post a note on a doc page which was the big feature blogged about. After creating an account I didn't have enough points. While I did spend ten minutes doing good stuff I only had a few points and more than a hundred to go with no way to get them. Clicking on the points page it tells me exactly what to do to get the most number of points to get me to 180 so I did just that. As I created a new thread (with a legit first comment btw) and only grinded on my own thread, I am not sure I can classify it as spamming either. The system told me what I had to do and I did it.

Really the problem is that basic functionality is several weeks of normal usage away and "180 points" a poor way of stopping bots.

icefox · wrote on 29 Jun 2011, 18:50

[quote author="Gerolf" date="1309373030"]I think it could be stated on both: JIRA and doc note, but JIRA is a must, doc not an option, right?[/quote]

Wouldn't it eventually be the other way around? Wont the doc guys be monitoring the notes to incorporate and improve docs based upon comments?

On this topic I really doubt developer.qt.nokia.com accounts work on jira which will stop a log of people right there from reporting things

giesbert · wrote on 29 Jun 2011, 19:11

[quote author="icefox" date="1309373409"]Wouldn't it eventually be the other way around? Wont the doc guys be monitoring the notes to incorporate and improve docs based upon comments?

On this topic I really doubt developer.qt.nokia.com accounts work on jira which will stop a log of people right there from reporting things[/quote]

good point, should also go as suggestion to JIRA, as that is the stuff to report bugs and suggestion which should not be forgotten.

I'm not sure if the doc people are monitoring the doc notes on dev net, I hope so. But writing a JIRA entry is not the worst idea. :-)

icefox · wrote on 29 Jun 2011, 19:36

You can do so very much with a rich documentation site on the admin side of things. Their should be data mining out the wazzoo! The owners of modules (or anyone who want them) should get notifications of notes so they can be incorporated back into the docs (email, rss, tweat whatever). You can generate reports on what doc are used over and over (bad api, bad docs?) Users who search/visit for X also search for Y used to guild. What about referral links? Most links to QFooBar might be from examples and blog entries that would be perfect bottom of the page fodder or even for review to determine if that is a major missing part of the docs. I was actually really bummed to find that the Add Note was per class and not per function as that will jumble things up quite a bit, but adding notes was still a big plus.

Most of the time when I (user hat) have a doc fix I want to make a clarification on a function description or add a link to another class/function you might want to use. The rest of the time they are small errors. A typo, broken link, spelling error. Small enough to matter, but absolutely not big enough to go through the hassle of a full blow bug reporting system.

I think I might have confused the above goals with what might have only been a move to the nokia way of documenting things. The built in ability to comment might have been a nice bonus not the focal point of the move.