Game Development Community

January and Torque 3D Documentation

by Michael Perry · 01/30/2009 (9:15 pm) · 12 comments

"I Hear Voices In My Head"

(click text for link)
"Voices" by Rev Theory

The Voices...

Quote:"It's also to be expected that as the price increases so will the support and documentation."

"...if I don't have absolutely great documentation to help me understand the inner workings of the engine"

"However, my biggest issue isn't cost, it's support, documentation, and communications."

"Just please consider good documentation to be a part of the package. The whole product isn't all just code."

"Of course, I want those things, but the one thing that I absolutely demand is much simpler. Documentation. I want real non-wiki-based documentation. "

"I will buy the next version of Torque (for whatever the price) if documentation is addressed. Nothing more."

"The quality of documentation and support would need to be quite substantial to warrant that price point."

"I don't mean this as an insult to whoever created the documentation, but it sucks! "

"The documentation is a joke..."

"I share your disappointment with the TGEA 1.8 - mostly on the front of Documentation"

"The documentation and TDN are incomplete and messy"


There are quite a few more quotes similar to the ones you see above, but they are scattered across many different forums, blogs, and websites. I know developers need documentation, and are happy to have someone working on it full time, but I did not realize how important it is in determining the cost and success of an engine. I have read a lot more posts requesting new features, better functionality, simpler usability, and so on, but the documentation voices are branded in my mind.

These words lit a fire under my ass, but not to make someone eat his words or prove something to myself. I want to deliver for the simple reasons that it's my job (which I love) and because you (the Torque developers) deserve what you are asking for.

I'll let Brett handle the major blog about Torque 3D documentation, but for now you can join me in the Torque 3D Documentation Discussion and the GG IRC Channel.


What Went Down In January

On top of rolling out Doc System 2.0, a major task I had to work on was getting the docs ready for the new site. With a lot of help from the web team, documentation now has a new home. Instead of having to post multiple links, I am very happy to just have to post one:

Documentation.

Navigation is so much easier now, and the system they have set up allows me to modify the Landing Pages and Official docs with greater ease and efficiency. Very big thanks to Derek Bronson, Jacob Fike, and Ken Holst.


First IRC Hour of 2009
Lucky for me, the week that the new site rolled out ended up being the same week for 2009's first IRC Hour. What could have been virtual lynching complete with pitchforks and torches, the GG presence was well received. I was able to help field a few questions about Torque 3D, documentation, and some other tasks. I really appreciated the civility and passion I was able to experience.

Click here to download the IRC Hour Log in Word format.


Video Tutorial Series Gaining Momentum
If you haven't been paying attention, Lara Engebretson is releasing some seriously high quality video tutorials.

Be sure to keep an eye on the GarageGames Vimeo Albums for more of her work.


Next month...


The next IRC Hour will go down Feb. 19th, at 5:00pm PST. If you wish to post topic suggestions, provide feedback on past sessions, or just view recent logs, head over to the 2009 IRC Hour Discussion Thread.

February is going to be another one of those "heads down, full steam ahead" months for me. If Torque 3D and our other engines are going to receive the documentation treatment you all expect, my temporary low key presence in the forums will be worth it in the end.

I look forward to being a part of some great discussions in the feedback threads and IRC Hour. Rock on GG community, rock on =)

#1
01/30/2009 (9:31 pm)
Any chance you could get rid of the scrolling panel the documentation seems to be placed in?

Seems strange to have to scroll down using an internal panel, then when you reach the bottom having to move over to the real browser scroll bar to scroll down the last few paragraphs. I imagine it could get quite annoying if you're jumping around the docs a lot too.
#2
01/30/2009 (9:40 pm)
Hey Michael,
Don't get discouraged. I've seen what you've done for Torque X and am very happy with it. I think a lot of people are going off a general rep that Garage Games has historically had with lack of documentation and may be having a hard time actually finding it or not looking due to said rep/misinformation. Here's a quote:
Quote:(and of course as everyone always mentions, not a bit of documentation seems to match any of the others, or reality)
Reference
and once they have the link I usually don't hear any complaining. Here's the last talk of it from same reference:
Quote:Also, thanks for the link to the online docs!
So anyway, keep up the good work and I think that exposing the new documentation
in a more obvious way such as make it a tab on the main documentation page instead of a link will go a long way!

Brian
#3
01/30/2009 (10:28 pm)
Michael, you are doing an awesome job on the docs. Just keep plugging along and soon they will be complete.
#4
01/30/2009 (10:58 pm)
One of these days I'll get around to checking this thing called Documentation out -- I hear a lot about it. But from from what I've seen and heard you're doing an awesome job at it. Keep up the good work, because even if I don't use it, it's still appreciated by just knowing that it's there.
#5
01/31/2009 (3:01 am)
C'mon Mich, dont let you down. You do a fantastic job, and you know it. Many of us know, and appreciate it as well.

Everynight I light up three candles: two on my Boondock Saints statuettes, and one on a framed picture of your centaur incarnation.

You have to understand though, that those sentences that you quoted will not go away... its just the way it is, some people will scream and rant, no matter what.
#6
01/31/2009 (4:04 am)
Thanks everyone!

Don't get me wrong, though. Those quotes are not getting me down. I might get a little ruffled when I first read them, but they are a permanent reminder of how important documentation is and what I have to do make it the best it can be. I'm not saddened or discouraged by those words: I become invigorated and motivated.

@Novack - +1 for Boondock Saints, +1 for Centaur Mich =)
#7
01/31/2009 (5:29 am)
There is nothing more frustrating than to have an issue, so you need to look something up in documentation and can't find it. It's a vital tool in troubleshooting issues so it needs to be searchable.

Note: Your link above to Lara Engebretson results in a "HTTP/1.1 404 Not Found" page.

#8
01/31/2009 (10:09 am)
Ahh well if it motivates you then the documentation is crap, it's getting worse and the back of a Rice Crispies box is more use - muahaha just kidding Michael, you're doing a grand job so far and looking forward to seeing the documentation come on in even bigger leaps and bounds.

Anything we can do to help you pull stuff together? Obviously can't add much to the new stuff in Torque 3D but I'm a great proof reader much my team at works disgust.

#9
01/31/2009 (7:59 pm)
Quote:...but for now you can join me in the Torque 3D Documentation Discussion and the GG IRC Channel.
That discussion thread is still locked :(
#10
01/31/2009 (8:33 pm)
@Tony - Hmm, that's weird. Which thread are you talking about? Both look like they can be edited.
#11
02/01/2009 (12:53 am)
Ah, yes it's open now, thanks. It wasn't when I posted.
#12
02/06/2009 (1:56 am)
Anyone know an IRC Client for Windows Mobile? I have a sweet phone now, Touch Pro from Sprint that I would love to use for these chats.
Since I'm at work at the times that these happen I would love to join in on them.
Plus my Unlimited Data Plan really makes it all the worthwhile
Thanks!