Search Unity

Unity Unity Docs feedback survey - participate and win some swag!

Discussion in 'Documentation' started by jo-unity, Sep 25, 2019.

  1. jo-unity


    Unity Technologies

    Mar 27, 2019
    The Documentation team at Unity is currently carrying out a survey to get feedback on areas we can improve our docs, and also to understand a little bit more about you and your documentation needs.

    The link to participate is here:

    We'd really love it if you could help us out here. And as a thank you for giving us a bit of your time, we'll give some special Unity swag to 10 randomly selected respondents.

    Thank you!
    Lurking-Ninja likes this.
  2. Baste


    Jan 24, 2013
    The "rank these features" thing doesn't specify if 1 or 7 is the "most important". I assumed 1 was most important since that's what value it got at the top of the page, but I wasn't quite sure.

    Also "how likely are you to recommend Unity documentation to a friend"? Very unlikely, as I'm not socially awkward enough to recommend somebody to read some docs. Did you copy-paste a question from a toothpaste survey?
    JoNax97 likes this.
  3. ollyhell


    Unity Technologies

    Feb 14, 2018
    Hey Baste, thanks for taking the survey and taking the time to leave feedback too.

    Ranking order is normally implied but we tweaked the question text to make this explicit in case anyone else had the same question. Thanks for highlighting.

    If someone was trying to use Unity and asked you if the docs were any good, would you recommend them or not? I guess that’s what we’re trying to work out (if you can forgive the Net Promoter Score phrasing, it does generate a score that we can benchmark against all the cool stuff we’re working on to improve the docs...)

    Hope this helps and thanks again,
  4. JoNax97


    Feb 4, 2016
    I just answered the survey and wanted to make a remark: I gave relatively high answers in the quantitative sections,refer but that only applies to the main docs. The packages docs I would rank them at like 2 steps below both in amount and depth of the info, and usability. Finding info on a specific version of a package is cumbersome, and many packages' docs are little more than crash courses right now.

    Still, I think the combo documentation-forum-answers is one of the strongest points of Unity. Keep it up!
  5. APSchmidt


    Aug 8, 2016
    I didn't answer the poll because I would have to answer "sometimes" or "rarely" to all questions.

    About the scripting API, I just made a search for "foreach" and got no answer that suited me. I eventually understood that you put in the API only what is relevant to Unity, not the basics of C#. To refresh my memory about foreach, I had to go to the Microsoft documentation.

    I suggest that you had links to the Microsoft documentation for each C# basic search we can make.
  6. jo-unity


    Unity Technologies

    Mar 27, 2019
    Hi @APSchmidt thanks for the feedback. We cover some of the basics of Scripting over in our manual

    To use Unity, we make an assumption that you already have some C# knowledge, and as such, you should use our API docs in conjunction with the fundamental docs that Microsoft has on C#. We don't cover any detailed information on the basics of C#.

    However, I think we could do a better job of making it clearer that you must have an understanding of C# on the home page for our API manual, as right now it does not mention this.
  7. BenVenNL


    Oct 14, 2019

    I have no C# experience at all. It is hard to start without this knowledge.

    I do have approximately 800 hours of self-taught VB knowledge in combination with MS Office. So there some basic knowledge of scripting logic and that helps a lot in my case.

    Maybe, as a newcomer to the community, I might not have the insights needed to form a well-founded opinion on this matter. But still, I’ll give it a try.

    If I look through topics posted on the forum I see a lot of people giving it a try doing a solo project.

    If a person (or small start-up) is trying to create some kind of entertainment (game/movie/animation) there is mostly a creative drive to do so. Learning scripting is like learning to chisel when trying to make your first sculpture. It's the hard labour to give your creativity a shape.

    I have some friends in programming, they are absolutely non creative persons. They see everything in black or white / yes or no, without nuance. No creative blood what so ever.

    Your customers have to be of the creative type, or there will never be any good end product, just solid scripting and clones of AAA titles with no chance of succeeding without huge marketing budgets. Creative persons mostly don’t have affinity with large text of abstract scripting.

    I don't think telling people preferred requirements will help. It will only tell potential customers "don't expect any extra service from us", "you’re on your own from here".

    Unity is the block of granite you want to sell, but if you aren’t willing to teach people how to chisel you won’t sell those blocks of granite.

    The tutorials you guys offer don’t tend to the needs of the ‘creative’ either. The whole 'karting game' thing is just too overwhelming at first. It’s an interactive tech demo for promotional purposes. You don’t need to convince the user anymore, they downloaded Unity already, they are willing to invest in this.

    This ‘First game’ is like you are telling us our first work immediately should be a Sculpture of David. It should not, it should be programming doodle, it should be about bouncing a red cube on a small surface using the ASDW-keys, making a score counter and adding a few different scenes where the surface differs in shape.

    Basic stuff. Help people with the 'hard part', starting a new project. Not editing a existing one. If there is creative blood in the user that sculpture will come eventually.

    If you are willing to teach yourself there is still the hurdle of information, or lack thereof.

    From my own experience, as mentioned at the start of this post.

    If I enter "VBA EXCEL" followed by any type of question or statement in a web search engine I usually get a clear answer within the first 3 search results.

    If I enter "Unity C#" followed by any type of question or statement, most of the time I get search results that don't apply to my situation.

    So I have to trouble the forum dwellers of this site to provide me with answers. So work speed is slow having to wait a day for people to react to my questions. I have a daytime job so that’s not really an issue for me, but probably for people investing more time in this it will.

    The search function on this forum is not helping either. It would also help if I could filter only on 'forum' or 'specific forum topics' to search in. Most of the results I’m getting are referencing tot the Manual while I’m mostly looking for are C# scripting solutions.

    This is/was not a mad rant of some angry frustrated guy it’s more of an answer to your OP question “ … to understand a little bit more about you and your documentation needs.”

    Well, for what I’ve experienced now, the scripting side is where most of the action lies and most of the hurdles are, and that is just the thing you are saying you don’t want to get involved in.
  8. andyz


    Jan 5, 2010
    As a long time user the main issue is things being wrong or outdated.
    There just does not seem to be enough people checking and fixing the content.

    For newcomers a better intro explaining C# usage with Unity and monobehaviours vs straight C# classes might help. Not all of your code has to be monobehaviour classes yet I've seen it happen.
  9. Abigail788


    Jan 2, 2020
    I just addressed the study and needed to say something: I furnished moderately high responses in the quantitative sections,refer however that just applies to the fundamental docs. The bundles docs I would rank them at like 2 stages beneath both in sum and profundity of the data, and ease of use. Discovering information on a particular variant of a bundle is bulky, and numerous bundles' docs are minimal more than intensive lessons at the present time.
  10. JoNax97


    Feb 4, 2016
    Did... did you just rephrase my answer with random synonyms? Are you a bot?
  11. Kybernetik


    Jan 3, 2013
    Question "13. Please rank the following in order of importance to you" is missing a few key items:
    • "Good descriptions" seems like an obvious one, yet many pages do barely anything more than repeat the method name.
    • "Usage recommendations" should be there so I can give it a low priority. In many cases the documentation just tells us how we should use something, which is really unhelpful when we want to do something slightly different and don't know if it will be covered. Explaining what things actually do and how they work should always come before telling us how we should use something.
    • "All features being documented" seems like another obvious one, yet the Motion class (the base of AnimationClip) still doesn't have any of its non-inherited members listed. Then there are things like PreviewRenderUtility and ReorderableList which are extremely useful but are not even listed in the documentation.
  12. Player7


    Oct 21, 2015