Does Unity3d's documentation need some beefing up?!

Hi guys,

Huge props for the work done by UT so far and for how much this it will help web 3d take off in a big time manner.
I am so eager to get my hands on the UT 2.5 Windows version. In the meantime, I am learning as much as I can so that I can hit the ground running.

One thing that I have noticed, and I want to write about, is that, imho, the documentation at the API level is rather limited. The code samples could also benefit from more details.

I understand that most of the effort went into the platform. Especially 2.5. Once UT is open to Windows, I am sure the adoption levels will be seriously influenced by the quality of the training and documentation materials. Is UT planing to focus more on community outreach and developer evangelization?

Nonetheless, it is going to be so much fun to get coding with UT2.5 on my PC.

cheers, Mongol

Referencing Tom Higgins’ 2009: Three resolutions for the new year, I’d say yes.

By the way did you check out the unifycommunity wiki? Its a community-driven site full of script examples, tutorials, guides etc. should be part of any good unityeers arsenal.

I actually think that the Unity API documentation is significantly better than most I’ve worked with. While I’m always supportive of more clarity and examples (some of the API elements don’t have any so definitely beef it up there) have you tried looking at Apple’s Cocoa and iPhone API docs… now those suck. Microsoft’s MSDN .NET docs are actually some of the best I’ve seen in terms of completeness with lots of examples.

I agree, the quality level of the documentation was a big plus for me, especially coming over from Torque. That doesn’t mean there isn’t room for improvement, however.

I’m not so sure about that one. Yeah they’ll have an example if you look up, say an array. However that example, instead of just showing you how to declare and reference the array, will be 3 pages long! I always get the feeling of having to sift through it with a comb. Too much of a good thing?

Being as I’ve been quoted I figure I’ll post up… :slight_smile:

We’re proud of the docs we have and think that they’re quite good. But at the same time we also realize that they have quite far to go and as such they’re an ongoing process that will get regular updates as we move the product forward.

Do they need beefing up? You bet, there’s lots of room for improvement!

The best additions are those small code examples that seem relevant to typical game situations.

I’d rather see 3-4 small code examples than one giant one (like the MSDN often has.)

It’s so great when they are there and so sorely missed when they are not. :slight_smile: It’s too bad the docs don’t have a collapsable comment section under each page. Users could put in there own example code, etc.

Personally, I’d like to see a printed manual made available for purchase. Maybe in two books, one which would be a manual for the tools (complete with a series of walk-through tutorials) and one that would be a clearly written language reference guide.