2011 Software releases
Learn about the 2011 versions of some of Autodesk’s Digital Entertainment Creation tools.
  • 1/2
You are here:Forum Home / Autodesk® MotionBuilder® / Open Reality / How would you improve the documentation?
  RSS 2.0 ATOM  

How would you improve the documentation?
Rate this thread
 
33044
 
Subscribe to this thread
avatar
  • Total Posts: 2
  • Joined: 2009-02-03 22:51:33

Hello,

I’m working on the MotionBuilder SDK documentation here at Autodesk, and I’m looking for feedback from you regarding ideas for improvements.

Would you like to see in the Open Reality docs:

* tutorials, starting with “hello world” to advanced topics?
* are the code samples useful? do we need more, and if so what?
* “cookbook” or “howto” style content?
* “big picture” descriptions of how the classes fit together?
* more content in the reference guide, and in any particular areas?
* anything else, other comments?

It’d be great if you could let me know which of the above would be most useful. You could rate them from 1 to 5 where
1 = critical
5 = low priority

Please reply to me onlist or just send me a message. Thanks for any feedback!

John Cornellier
SDK Documentation
MotionBuilder, Autodesk

PS: This is cross-posted to the MotionBuilder Python forum.



Replies: 0
avatar
  • Total Posts: 7
  • Joined: 2008-06-14 01:16:25

Hello,

I’m ecstatic to hear that the Open Reality SDK’s documentation may be receiving an overhaul.  It does need one drastically.  I’ve been exposed to Open Reality for approximately 2 weeks now and have a plethora of questions that do not seem to be readily accessible.

Personally I feel two things are paramount:

Beef up the glossary with all terms that are used in both the application and the API itself.  One question I have to answer for myself is what a ‘connection’ is.  Class declarations, too, should have more than a ‘brief description’ that often sounds like someone looked at the name and scribbled a sentence-form meaning to page.

Once I think the glossary is strengthened, the searching capabilities can be improved.  For example, I would like to find an object that will tell me how to access the current time in the timeline.  I have used the Class List to infer a helpful class, but without closely examining the APIs within, I can not be certain. 

FBTransportControl class, etc.).  Many of us work from an angle of seeing how MotionBuilder does it and seeing how we can control that through code.

Hope this helps.

Kevin



Replies: 0




   
  Settings Choose Theme color: