Epic Documentation Showdown!
by Michael Perry · 01/02/2009 (8:40 pm) · 20 comments

Two Men Enter, One Man Leaves
Greetings everyone! It's not what you think. Despite my X-treme ladder match skills, I did not battle in a dome of steel with a chainsaw. My showdown was against documentation deadlines, and it felt like a battle to the death.
Something different...
I've broken my usual behavior pattern of posting multiple blogs in a single month. Additionally, my presence in the forums has been very light. If you have been following the major announcements you will know there have been three documentation releases in less than a month:TGEA 1.8 - With the release of TGEA 1.8, a new set of doc covering GFX2 and other major changes was necessary. The scheduling was a bit tricky, as two other engines came rushing out the gate concurrently.
iTGB 1.1 - iTGB 1.1 was released with multiple bug fixes, improved usability and speed enhancements. However, the iTorque docs are still in a fledgling state. I was able to get the TDN section for iTorque started and add some new information to the offline docs.
The major issue I tackled was getting iTGB integrated into the Doc System, which was a success. I can now generate iTGB documentation much easier and faster than before. I have also started working on video tutorials series which will launch at the end of January if all goes well.
TorqueX 3.0 - Finally, I wanted to have a new set of docs ready to go before the new version of Torque X made it out the door. I've already uploaded the revised form of Torque X docs to the site. This new set is a unified framework of TX Core, 2D, and 3D systems, sporting some new content.
Post-Mortem
While it was not quite as strenuous as a Full Sail Final Game Project, the November and December deadlines for updated documentation was an endurance test. However, I managed to push through each release and came out with a new strategy for docs.2008 In Review
It was a huge year for me. I was able to attend my first GDC and land a job at GarageGames. Presented my plan for documentation and have maintained its transparency (multiple links in that sentence).Additionally, I met some cool people (Leba, Apparatus, Tim), turned 26, and completed some of my side projects.
My favorite two events include being Photoshopped multiple times in a single thread and producing my first cardboard fort and video
Plans For 2009
The year will redefine the terms "EPIC" and "AWESOME." A new trend of mine is making bold statements, because I like the challenge. I do not make New Year's Resolutions, but I do have a laundry list:- Release my first game
- Launch a new page for Torque Video Tutorials
- Complete and deploy Doc System 2.0
- Produce more documentation content in 1 year than all of the past documentation effort combined
- Create a polished framework from scratch for Torque3D
- Complete my iPhone Pipboy 3000 project
- Attend GDC 2009
Documentation Rock Stars
Normally, I highlight community members who have been rocking the documentation front. However, this time I have to shine the spot light on employees and associates. I could not have made it through these past 3 engine releases without their help:- Lara Engebretson: Lara has been developing GarageGames' first video tutorial series. She is currently focusing on TGEA's world editor, by releasing videos that show you how to replicate an Oregon coast. She is the one who inspired me to jump on the video tut train, so I will be releasing my own videos for our other engines. You can find these awesome videos on Vimeo HERE
Videos Made By Lara Engebretson
Videos Made By Lara Engebretson
Kenneth Holst: In a shining example of impromptu team work, Ken and I have been working together quite a bit over the past two months with TorqueX and iTGB. I've been helping him QA the two engines, and he has been providing me with documentation feedback. I see the two of us teaming up quite a bit over the next year.
David Montgomery-Blake: Let's get down to it. David is just awesome. There is no denying his skills as a communicator, moderator, and ambassador. On top of helping me spread the documentation word around our forums, David is an active member in other communities. He isn't a viral marketing guy, he actually owns multiple game engines and advocates them all. His efforts to defend my documentation and spread the good word have been a huge help.
Team X-Treme: Yeah, I'm stealing this from wrestling. If you can post the reference, I'll include you in the betas for my games this year. For this blog, I'm referring to the above two guys. I plan on working closely with Ken and David in 2009 to deliver a an unrivaled community experience. We will be targeting Indies, Pros, and Hobbyist alike, even if you do not own Torque.
John Kanalakis: Master and lead developer of Torque X, John has written a fantastic book: The Complete Guide to Torque X. If you want immediate learning results for TX, pick this book up NOW. John was generous enough to lend me passages from his new book to include in the new Torque X documentation. Having him develop the engine as well is like a double-bladed sword of awesomeness.
Please join me in giving a huge thanks to the above people for there help in getting new documentation to the community!
My Ultimatum
Before 2009 even gets close to ending, no other game engine will offer the level of documentation that our Torque products will have.
Happy New Year Everyone! You'll be hearing more from me soon!
About the author
Documentation Engineer for Torque
#2
01/02/2009 (9:03 pm)
Fantastic! Thanks Morrock!
#3
01/02/2009 (10:19 pm)
I love those terrain editing tutorials, but I thought Deborah was doing them? Either way, they are great, and I hope to see more such tutorials in the future :)
#4
01/02/2009 (10:31 pm)
The documentation has made a dramatic change and can't wait to see what is coming next. The tutorials are great, I work helping to develop training material at work and I can tell you people learn faster from video and examples that they can see the results happen.
#5
01/02/2009 (11:05 pm)
Hey Rodney! I was posting them since I have a GG Vimeo account, but yes, Mich is correct that our most excellent video expert and artist Lara Engebretson has been the mastermind behind the videos. She will also be doing an update to them for Torque 3D soon, so stayed for those at our new consolidated GG vimeo account here. In fact, once the new website goes live, all GG videos will be stored here, so this is the place for GG videos online.
#6
01/02/2009 (11:29 pm)
Damn fine work on the docs! The old "bad docs" argument has been rendered null and void for some time now, and you are definitely to blame for that...er, I mean credit!
#7
01/02/2009 (11:34 pm)
Quote:Damn fine work on the docs! The old "bad docs" argument has been rendered null and void for some time now, and you are definitely to blame for that...er, I mean credit!I'll second that and Lara's video tuts rock. :)
#8
01/03/2009 (12:11 am)
I'm so glad to see some updates to the TorqueX documentation. It doesn't seem to work well in Firefox, though :(
#9
Careful! You'll get held to that!
And thanks to Deb's new video docs I not only now know what FresnalBias is but also how to pronounce it!
01/03/2009 (12:15 am)
Quote:Before 2009 even gets close to ending, no other game engine will offer the level of documentation that our Torque products will have.
Careful! You'll get held to that!
And thanks to Deb's new video docs I not only now know what FresnalBias is but also how to pronounce it!
#10
Not a wrestling fan myself, although I do enjoy a good biography every now and again.
You have been doing a fantastic job, Mich. I have written a bit of documentation in my lifetime, but can't imagine the headache you walked into willingly. Keep it up!
01/03/2009 (12:17 am)
Quote:
Team X-Treme: Yeah, I'm stealing this from wrestling. If you can post the reference, I'll include you in the betas for my games this year. For this blog, I'm referring to the above two guys. I plan on working closely with Ken and David in 2009 to deliver a an unrivaled community experience. We will be targeting Indies, Pros, and Hobbyist alike, even if you do not own Torque.
Not a wrestling fan myself, although I do enjoy a good biography every now and again.
You have been doing a fantastic job, Mich. I have written a bit of documentation in my lifetime, but can't imagine the headache you walked into willingly. Keep it up!
#11
@Deborah - Thanks for the helping clear that up
@David - I'll take full blame and credit, though both seem to end up with me quivering in the fetal position in a corner =)
@Randy, Rodney - Glad you guys like the video tutorials
@Takuan - I too am happy to see some updates to TorqueX docs, just as I am happy to work with the updated engine. Lots of people should be pleased with what's being released. I will be updating TorqueX docs next week so that they work better in all browsers.
@Steve - I plan on being held accountable =)
@Jacob - Winner! You will be the first beta tester for my projects this year. Thanks for the support of a fellow doc writer
01/03/2009 (3:20 am)
Wow, thanks for the awesome support everyone!@Everyone
- The videos are authored by Lara Engebretson, but hosted on Deborah's account. We have an official GG vimeo account which will host the series when it is finished.@Deborah - Thanks for the helping clear that up
@David - I'll take full blame and credit, though both seem to end up with me quivering in the fetal position in a corner =)
@Randy, Rodney - Glad you guys like the video tutorials
@Takuan - I too am happy to see some updates to TorqueX docs, just as I am happy to work with the updated engine. Lots of people should be pleased with what's being released. I will be updating TorqueX docs next week so that they work better in all browsers.
@Steve - I plan on being held accountable =)
@Jacob - Winner! You will be the first beta tester for my projects this year. Thanks for the support of a fellow doc writer
#12
gg wise, things are looking very interesting for 2009 :)
01/03/2009 (2:06 pm)
I have to say Deborah's cardboard fort was definitely one of the highlights of 2008! Absolute Classic! :Pgg wise, things are looking very interesting for 2009 :)
#13
01/03/2009 (8:28 pm)
Awesome job on the docs Mike. Keep up the good work and thanks for mentioning me =)
#14
01/04/2009 (4:42 pm)
Excellent Job Michael. Certainly has made a difference.
#15
01/05/2009 (7:16 pm)
Is part 7 of this video series just not complete yet? These are some of the best tutorial videos for torque I have ever seen.
#16
@Tim - Thanks for being a cool contact during 2008 =)
@Julian - That's me...making differences and turning heads wherever I go (ahhh, there's that unwarranted hubris)
@Michael - I agree. Best video tutorials to date. Lara is working on the 7th one now.
01/05/2009 (7:46 pm)
@Leroy - Glad you liked the Fortress. It was a blast constructing it and making the video@Tim - Thanks for being a cool contact during 2008 =)
@Julian - That's me...making differences and turning heads wherever I go (ahhh, there's that unwarranted hubris)
@Michael - I agree. Best video tutorials to date. Lara is working on the 7th one now.
#17
School was a while back and strange things tend to happen, but I sure wouldn't have predicted you'd be the most prolific author I'd read in 2009. Keep it up!
01/06/2009 (7:35 am)
Wait... LESS work than your final project? GG... you need to work this guy HARDER. :)School was a while back and strange things tend to happen, but I sure wouldn't have predicted you'd be the most prolific author I'd read in 2009. Keep it up!
#18
When GG requires Ghantt charts and turbo team meetings, then I'll rethink my stress level compared to final project.
Thanks for dropping in, and for the support. See you at GDC again?
01/06/2009 (7:57 am)
@Tim - Prolific? Way to cater to my hubris =)When GG requires Ghantt charts and turbo team meetings, then I'll rethink my stress level compared to final project.
Thanks for dropping in, and for the support. See you at GDC again?
#19
That, and he's now in charge of grammar-checking every single forum post on the GG site. That'll keep 'im busy... :)
01/06/2009 (8:04 am)
Done. At the end of the day, Mich is now required to use Gantt charts to describe his minute-by-minute work days, and he's in charging of turbo charging all Torque related meetings. That, and he's now in charge of grammar-checking every single forum post on the GG site. That'll keep 'im busy... :)
#20
@Leroy- Agree, the fortress video is oscar worthy. Sometimes I watch it just for a pick me up, so funny.
To all of GG: Crazy HUGE congratulations on the Frontline award...Im glad your hard work is being acknowledged.
Here's to 09!
01/06/2009 (10:37 pm)
@Mich- You are too sweet. I am so honored to ranked in your cool people of 08! Its better than being on the best dressed list.;)@Leroy- Agree, the fortress video is oscar worthy. Sometimes I watch it just for a pick me up, so funny.
To all of GG: Crazy HUGE congratulations on the Frontline award...Im glad your hard work is being acknowledged.
Here's to 09!
Torque Owner Morrock