Please improve the API documentation, e.g. with code examples
The documentation of the Ranorex API is extremely minimalistic, making it very hard (if not impossible sometimes) to understand and use it. In my opinion, most explanations for classes, attributes and methods are so short that they provide no help at all. Information on how to work with the classes in context is missing. In rare cases you'll find some examples in the forum, but in general you're lost. Please take the trouble to really improve the API documentation. And/or offer some Advanced Training for automation engineers who want to learn the API. Thanks!
fk4rx
shared this idea
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.
Best Regards,
The Ranorex Product Management Team
8 comments
-
Update: We have assigned this to our docs person. You should see improvements and examples added soon.
-
Michal Szymczyk
commented
Documenting the whole Ranorex API is probably a big challenge and time consuming but as people mentioned earlier, we really need that! You don't need to release the entire documentation - it would be great if you just update it regularly :)
-
Yosuva
commented
Need examples for all the API usage.
-
fk4rx
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).
-
Anonymous
commented
Why Documentation need with Example is :- Most of the time Manual teams get trained and moving over to automation . With less development experience , It is hard to go over API documentation. Ranorex is doing good, but why not this Examples.
-
Aidan Mc Donnell
commented
Yes please documentation need update to include Web and mobile usages
-
Arnold
commented
Yes, please.
Plus Ranorex documentation needs a refresh. Most important for mobile.
We need a fully documented, with technical details manual.
Not a getting started guide, A.K.A. user guide, with hints, but no explanation or background. -
Milan Dugovic
commented
Having code examples directly in Ranorex API documentation would not only simplify the work of those who like to code but would ultimately reduce rate of unnecessary posts of those on forum who are seeking for appropriate and dynamic solutions.