Thank you all for bringing this to our attention. This topic is currently the number one topic in our User Voice. We are aware that our API documentation is far from perfect, and we see the value in improving it ourselves.
We are currently investigating the options we have for this API documentation. We are not sure yet about details like the format or the platform. Additionally, there are some parts of the API are not meant for public use and only enable Ranorex Studio to do specific things, etc.
This means, we are aware of the issue and we are trying to figure out how to tackle this best.
The Ranorex Product Management Team
An error occurred while saving the commentfk4rx commented
Yes, please focus on the part of the API which is meant for "public use". The current documentation has, in my opinion, 2 major weaknesses:
(1) many descriptions of classes and methods are "minimalistic" in the sense that they basically repeat words from the class or method names (as if those were self-explaining...); or they are simply too short to be understandable.
(2) it is too often very hard to figure out how classes can / should be used together with others to do important things
Problem (1) must (in my opinion) be addressed first, by providing more helpful information about the meaning / purpose of at least the most important classes and methods of the "public" API.
Problem (2) has been addressed by providing more examples in the new User Guide, which is a good thing. But a collection of examples is no replacement for the documentation of the building blocks (classes).fk4rx shared this idea ·