Announcement

Collapse
No announcement yet.

How can we improve UE4 Documentation?

Collapse
This is a sticky topic.
X
X
 
  • Filter
  • Time
  • Show
Clear All
new posts

  • replied
    Update the blurbs and notes regarding what things work / don't work / how those work in the old versions (4.22 and older), so it's updated to whether those work / don't work / how they work in 4.23+.

    Though it's not in the documentation, get rid of the wiki link in the top main navbar of the Unreal web site until there's actually a whole wiki available and readable. I suggest not even making a wiki, but I'm sure that's too unpopular of an opinion to be considered.

    Put more specific use-cases with pictures from actually doing it in the Unreal Engine throughout the docs. It doesn't have to be full-fledged, final products ready to get sold in the marketplace. But at least showing, in some cases extensively or in a bit more detail than is currently shown, what exactly is involved in accomplishing the effect / using feature(s) / placing it in the scene.

    Try summarizing the point at, click, click & hold, left mouse button / right mouse button, etc instructions. This is repeated in a number of basic how-to's and other articles. It could be something such as:

    LMB click-hold, drag to viewport, release
    R-click in material graph, type "texture", click "Texture_Sample" (node is placed where cursor is)

    Use those kinds of instructions rather than spelling out every word and forming what, by stricter English standards, form length, run-on sentences. It's easier to read and even makes the docs more approachable for beginners / intermediates / experts alike.

    Leave a comment:


  • replied
    Suggestion related to the documentation sidebar / table of contents: It would be nice if the topics were sorted in a more meaningful way. For example, Engine Features -> Rendering and Graphics starts with "Fog Effects", then "Virtual Texturing" and only then "Rendering Overview", which IMO should come first of all.

    Leave a comment:


  • commented on 's reply
    Thanks for your feedback! You may find the following information useful:

    Multiplayer in Blueprints
    https://docs.unrealengine.com/en-US/...nts/index.html
    Last edited by Jim.Bradbury; 06-02-2019, 03:57 PM.

  • replied
    Can you add documentation about blueprint online multiplayer implementation ? Thanx

    Leave a comment:


  • commented on 's reply
    Thank you for your feedback! I agree that there are some very 'stale' topics in the documentation. The documentation set is large, and we are looking at ways to efficiently stay in-sync with the Engine releases. We have recruited some help, so you should see more on-going updates than in the past.

  • commented on 's reply
    Hi, and thanks for the feedback! We are aware of the limited documentation available for the new audio engine, and are aggressively working to produce some quality Online Learning tutorials, as well as a rich set of traditional documentation. I can assure you that the Audio team 'feels your pain', and is pushing us hard to get some materials out the door. Thanks for your on-going support and patience!

  • replied
    Hi! my name is John and I'm working with Unreal for a long time, the sound into Unreal is my job but when I need some information about it in my opinion is very limited and with the old version (4.12, 4.13) I'd like to have more information/tutorials about new audio system, new ambisonic implementation, etc, with the newest version of Unreal.

    The sound is one of those forgotten in production.

    Anyway the changes you're making in the documentation is amazing and look nicely

    Thanks in advance

    Leave a comment:


  • replied
    Hello! One thing that would be useful for the documentation is updating it as Unreal's features change. Material properties for example is still stuck on version 4.9. There are several differences between version 4.22's properties and version 4.9's. I'm sure it's not the only section that needs updating.

    Leave a comment:


  • replied
    VR_Nima Thank you for your feedback! We are investigating solutions along the lines you describe above.

    Jim Bradbury | Learning Resources | Epic Games

    Leave a comment:


  • replied
    I feel very strongly that a Forum post is the WRONG way to solicit feedback about documentation.

    There should be a button on EVERY page of documentation that allows users to submit feedback, which will be ticketed with the link to that page of the Documentation. This can be done off-the-shelf with Zendesk, but I'm sure Epic Games can figure it out somehow.

    Users should be able to click the button and send feedback about that page of documentation to Epic, point out what's erroneous about it, how it can be made more clear, point out what the user would have liked from that page, etc. That would make it SO much easier for users. When I couldn't find a similar button like that, my next step was to go search the forums, and lo and behold, this is where you want users to submit their feedback. I can imagine that extra, non-intuitive step of added friction will have Epic missing out on a mountain of feedback from users who are effectively doing the job for you(pointing out what's out-of-date/wrong and how to fix it).

    Leave a comment:


  • replied
    So here is my burn down list that I would personally like to see:

    -Epic having a procedure in place where when they answer a question (such as on answerhub), they follow up by checking the related documentation and adding that answer into the documentation so that we stop having so many repeated questions. If you are seeing questions, it is often because either it is darn difficult to FIND the answer, or the answer is not communicated clearly. So, start using your questions in Answerhub as the guide for updating your documentation.

    -A document/weblist listing all default blueprint nodes, grouped as they are grouped by default in the right-click context menus, detailing the functionality/use of the node, preferably with links to default input/output nodes.

    -Consolidation, perhaps curated by topic, of previously answered questions to reduce the overwhelming number of Q&A threads. (Essentially step one of the first suggestion). This would make it easier for us to find the answers we need without having to ask repeat questions, and give those answering a single target source to point questioners too.

    Leave a comment:


  • replied
    Tim Hobson

    Sorry for late reply :s

    I wrote "Change viewport Android" because I didn't know it was called a "Preview". It's just me but I think C++ coding (scripting) is not enough highlighted and as a coder (more a Engine's C++ User) It's too bad that BP take so much place.

    I know it's not the subject but do you have the new Wiki's release date ?

    Bests,

    Alexandre

    Leave a comment:


  • replied
    Could Epic please add more docs on AI with examples ? (Nav Link Proxies, Smart Nav Link components, AI Perception, etc.)

    Leave a comment:


  • replied
    I just noticed that I find the documentation pages a lot more useful than before, good job guys

    One thing I still would like to see: I think allowing users to edit documentation pages would tremendously improve the documentation. I know that it's a bad idea to allow just anyone to update pages, but I think this feature could prove doable if you guys also implement some sort of reputation.

    People can only freely update pages when they have enough reputation, otherwise their udpates have to be approved by someone with enough reputation. One can only earn and loose reputations by updating pages, earning reputation when their updates gets approved, none when it gets denied. Additionally penalties could be dealt out for bad updates - whether they have already been approved or not - which would make you loose reputation. The penalties could/should be large enough to scare people off

    Leave a comment:


  • replied
    Documentation keeps getting better all the time.... kudos. With such a large documentation base that changes over time, it would be really useful to see recent changes like a "documentation changelog".

    Keep up the good work :-)

    Leave a comment:

Working...
X