Hi,
first of all, thanks a lot @SyntaxError for the initiative! I think most of the following things were already mentioned, but I will still add my 2 cents.
Which documentation resources do you use most often? (Automation Help, user’s manuals, Downloads section, etc.)
I am mainly using Automation Help, most of the time sticking with the offline version. I use user manuals and Downloads section for specific cases. Otherwise I am also using the Community, and online courses and training manuals from the Automation Academy.
How easy (or difficult) is it to find what you need?
The search engine could definitely be better (both offline and online). It happens quite often, that even when I write exactly the name of the page I am searching for, it is not the top result. Also, in the online help, the path which is shown under the result is in German, which can only add to the confusion. For these reasons, I am basically using the search window only when searching for an error code, otherwise I just click and scroll through the tree to find what I need. However, this only works because over the years, I have learned what could be located where. I still remember how much I was struggling with this when I was new to B&R…
How would you rate the usability of our Downloads section?
Searching for product manuals is usually fine. Searching for AR upgrades and Technology Packages is quite a bit more cumbersome. If I for example search for “mapp Motion 6” (because I don’t know what exactly is the latest version and because I don’t know that it’s written as “mappMotion_6”), I first need to scroll through 100 versions of mappMotion_Codian, because the results are for some reason ordered alphabetically… I have found out that in this case it is actually much easier to use the general search through the complete website, instead of the search in the Downloads section.
Any features or improvements you’d love to see?
Better search engine. Or maybe even better, make our help contents searchable by Google.
In some cases better documentation
- There are some pages, which are almost impossible to understand when you are new to the topic, and they only start making some sense, when you already know what you are doing (my favorite are the explanations of different compensation gear variants in cam automat…).
- Some pages, especially for mapp components configurations, contain the table which looks like the actual configuration file in AS. On one hand this is nice to have the same look and feel and it makes it easier to search for the setting you need. But on the other hand, there is often no other explanation than what is already visible directly in AS. What is the point then?
What works really well that we should definitely keep doing?
The “Getting started” guides. Examples of some more complex use cases for some of the components. The fact that no matter the technology, basically everything can be found in the same help. Relatively consistent and clean look and organization of information across the pages.
Bonus question: If you could wave a magic wand and change ONE thing about our documentation, what would it be?
Searchability of our help from Google. This would already solve many issues and would also help to increase exposure.
Additional note: In one of the posts above, I have seen an idea to integrate videos. Please don’t!
Or only as an additional form, but definitely not instead of the text. There is nothing worse than having to watch a video, just because I want to check one small thing.
These are just my opinions, so feel free to disagree. Also, I didn’t mean to sound too negative and I really appreciate all the documentation work done by everyone involved ![]()