Have you ever wanted to tell us how our documentation rates; well now is your
We want to know; If you were to rate UE4 documentation, on a scale of 1-10 (1 being the lowest & 10 being the highest rating), what score would you give it? And donât be afraid to tell us why, we actually would love for you to tell us why.
Unreal Engine 4 documentation is amazing but some section need a little more love , so why , itâs very difficult to give a general rate.
Thank
[/QUOTE]
Hey ! Thank you for taking the time to rate and talk with us
Yes, this is a very difficult question but that is part of the challenge. And in a way, makes the information even more valuable at times. It makes you think of all the positives and negatives as a whole (to a certain degree) and then you start weighing those back and forth. And with the ability to see why you gave a certain rating, tells us what is important to you as the user and how that can affect your rating/view of a certain product (in this case UE4 docs).
Again, we truly appreciate the time you have taken to provide feedback to Epic.
[QUOTE=SaviorNT;268712]
I think it would be more appropriate to have a rating/feedback section on each documentation page.
[/QUOTE]
Thanks for the feedback Savior!
I think at some point we would like to have that feature in place, it has definitely been talked about before. The rating of our Documentation as a whole is just a different scope. Both the rating of individual pages and the whole site are very important. But with individual pages it is easier to see sometimes to see why a certain rating was given ( i.e. out-of-date page receiving a low rating). But when all those different pieces are combined, and then we see a user saying even after all the good and bad that their rating is a 7, well then thatâs pretty eye opening and very helpful to our doc team
If anything, each class and function should be âratableâ.
Of course you donât expect users to go through each class and function and rate it. What you do instead, is to provide facility which allows users to rate this particular class/function they are planning to use as they go along and develop their game.
By doing so you not only gaining very precise info on ârating scaleâ of particular class but also metrics which classes/functions are used mostly and which one are well documented and which one need attention.
With what you suggesting that is âwhat do you think about our documentationâ is rather like asking which car is best? Pointless question, you will get pointless answers.
What will happen when you get most of the answers: Your documentation is great? You will do nothing? And what if the majority of voters are beginners and donât really understand difference between what is good documentation and what is bad documentation? Will you decide about your future actions regarding improving or not based on votes from people who donât really understand what is good and bad documentation?
And what if you get most of the answeres: âYour documenation is poorâ? Will you try to improve it? Which part? Do you know? Or will you ask again, but this time to point to specific classes? And again, what if majority of users rating will be from the group, âI think Java is as good as C++ because you can create objects with operator newâ? What will you do then? How can you be sure about your group?
Thanks !
I will see what kind of request I can make to get the idea of rating individual class/functions as you pointed out. Definitely sounds interesting.
If possible, you do want to give users rating of very low scores with the optional option to let them provide actual feedback/comments on why the user rated the articles of that low score. And you want to provide a graph representation of the ratings in general for yourselves (Epic Staffs, not us), so that you can see if the article is improving, or is stagnated by something such as neglect. And you donât want that at all.
Also, when implementing ratings for articles, be sure that you cap it at 100 ratings. Because what you want are ratings that are more recent, and you need to discard old ratings, so that you can actually see if the articles are really improving at a glance. You only discard old ratings when the total accumulated ratings count exceeds 100.
[QUOTE=;270354]
If possible, you do want to give users rating of very low scores with the optional option to let them provide actual feedback/comments on why the user rated the articles of that low score. And you want to provide a graph representation of the ratings in general for yourselves (Epic Staffs, not us), so that you can see if the article is improving, or is stagnated by something such as neglect. And you donât want that at all.
Also, when implementing ratings for articles, be sure that you cap it at 100 ratings. Because what you want are ratings that are more recent, and you need to discard old ratings, so that you can actually see if the articles are really improving at a glance. You only discard old ratings when the total accumulated ratings count exceeds 100.
[/QUOTE]
Thanks for the feedback !
This is definitely something worth considering for when and if we do the individual page ratings. Definitely could be useful.
While Iâm on board with individual page ratings, I can see a number of logistical issues. The very biggest one is that the docs would have to go from being static to dynamic. This is simply because the only way to have those ratings and views of performance at a glance is to also have versions of those pages. If something is changed in the page and something goes away, that people found really helpful, then it would have to be re-written or possibly lost if there is no old version of the page. On top of that, The other one is that every page would need to be date stamped for last update, and this is something I want anyway, but I think it should come before adding ratings for every article, or page, or docoment sectin or what have you. Right now I think rating the documentation as a whole should really be abandoned as an idea. I think the last two respondents are accurate in their view. Itâs like comparing a speed demon gas guzzling sports car to a toyota prius. They are bought by differerent drivers for different reasons. The docs are not eaten as a meal off a menu. They are eaten as a buffet.
At the start I would say a solid 8 as what was there was fresh and relevant but with each release the trend is losing a point as the info is quick in being outdated or confusing. Kind of like reading a history book that says one day man will land on the moon.
