Quantcast
Channel: MicroStation Programming Forum - Recent Threads
Viewing all articles
Browse latest Browse all 4331

[CONNECT APIs] Documentation Improvement Requested

$
0
0

The current API documentation (MicroStation CONNECT Update4) makes it hard to find things.  In particular, topic overview descriptions that introduce a part of the API do not make themselves known.  Here's an example: in their answers to a question, Bob Hook and Paul Connelly mentioned Linear Transformations: RotMatrix, Transform, DMatrix4d, DMap4d in the MicroStationAPI.   The RotMatrix class is a 21st-century replacement for the mdlRMatrix_ family of C-style functions.

In two years of using the MicroStationAPI, I had not noticed either the RotMatrix class or its introductory topic Linear Transformations.  Even now, knowing that it exists, it's hard to find it in the documentation.  Yes, if you know the topic title letter-for-letter you can find it — but if you search help for, say, Linear Transforms that topic is not included among the search results. 

This is a catch-22 situation: if you know exactly what you're looking for, you can find it; but, if you don't know exactly what you're seeking you can't find it.  But the reason for using help documentation is to find things about which we are unsure.  Help doesn't help when we most need it.

The API documentation is generated automatically from source code.  It uses a form of markup unique, as far as I know, to Bentley Systems.  It needs development.  For example, overview topics such as Linear Transformations or Layout Manager Introduction should bubble to the top level of help contents, perhaps in their own Overview chapter.  

Here's another example: suppose I want information about ECClass.  If I know the exact class name, then a search succeeds.  Well, sort of.  The first few hits for that search are ECSchema.h Source File, Member List, Member List, ECClass Struct Reference, Class Members,Class Members - Functions ….  There's a lot of noise in that search result.  I would prefer to see some sort of overview rather than a link to the header file.  But what happens if I search for something not perfectly accurate, such as EC Class?  I see Class Hierarchy, Class List, Bentley::DgnPlatform Namespace Reference … again not too helpful for the person seeking enlightenment rather than obfuscation.  Of course, the help system is hampered by its format: Microsoft .CHM help doesn't do fuzzy searches.

Well, I've got that off my chest: just my 2¢.


Viewing all articles
Browse latest Browse all 4331


<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>