Official iT2D Documentation Feedback
by Michael Perry · in iTorque 2D · 09/27/2008 (11:01 am) · 102 replies
======================================================================
This Thread Is The Official Documentation Feedback Area For ALL Versions of iTorque 2D
If you want to quick search for all iTGB Doc Updates, perform a keyword search in your browser for
"Documentation Update:"
======================================================================
Hey everyone. It's about time we have a central thread for iT2D users to post their feedback in regard to documentation.
We have similar threads going on in the other forums forum, and so far the feedback has been overwhelmingly positive, constructive, and very helpful to the doc writers...so let's keep that going with iT2D=)
Purpose of the Thread:
- Provide a central thread for iT2D users to post their thoughts, suggestions, and criticisms about documentation.
Targets:
- Official documentation provided by TorquePowered, TDN articles, and user submitted docs/tutorials.
Suggestions for Posts:
- What is the #1 thing you would like added to the official docs?
- What area of the docs do you think needs the most work?
- What do you see in other tech docs, be it for other Torque engines or non-Torque tech, that you think would be beneficial to have in the docs?
- What are your feeling on TDN vs how the current official docs are presented?
- Bring attention to resources, tutorials, articles, or community member submissions you think should be merged into the official docs
...etc, etc
So, the overall concept of this thread is pretty simple. This is your chance to talk until your face turns blue about what you want from the docs.
Be as clear, descriptive, and specific as you can!
This Thread Is The Official Documentation Feedback Area For ALL Versions of iTorque 2D
If you want to quick search for all iTGB Doc Updates, perform a keyword search in your browser for
"Documentation Update:"
======================================================================
Hey everyone. It's about time we have a central thread for iT2D users to post their feedback in regard to documentation.
We have similar threads going on in the other forums forum, and so far the feedback has been overwhelmingly positive, constructive, and very helpful to the doc writers...so let's keep that going with iT2D=)
Purpose of the Thread:
- Provide a central thread for iT2D users to post their thoughts, suggestions, and criticisms about documentation.
Targets:
- Official documentation provided by TorquePowered, TDN articles, and user submitted docs/tutorials.
Suggestions for Posts:
- What is the #1 thing you would like added to the official docs?
- What area of the docs do you think needs the most work?
- What do you see in other tech docs, be it for other Torque engines or non-Torque tech, that you think would be beneficial to have in the docs?
- What are your feeling on TDN vs how the current official docs are presented?
- Bring attention to resources, tutorials, articles, or community member submissions you think should be merged into the official docs
...etc, etc
So, the overall concept of this thread is pretty simple. This is your chance to talk until your face turns blue about what you want from the docs.
Be as clear, descriptive, and specific as you can!
About the author
Programmer.
#2
Instead focus on iTGB specific things like how to hook into the events system and accelerometer, etc, how to deploy a TGB app into simulator, and onto the device. Differences in screen resolution and required graphics format.
09/29/2008 (11:27 am)
Apple has great docs on installing xCode and the iPhone SDK. Please don't spend a lot of time on soup-to-nuts documentation of this!!!Instead focus on iTGB specific things like how to hook into the events system and accelerometer, etc, how to deploy a TGB app into simulator, and onto the device. Differences in screen resolution and required graphics format.
#3
The next step is compiling an app and running it in the simulator. After that, run on a device. Then at the end of that, start documenting actual features like accelerometers, GUI, taps, etc.
09/29/2008 (12:08 pm)
@Alex - The xCode portion was already written for TGEA 1.8. I had to install the iPhone SDK, so there was no harm in documenting that. Took a whole 15 minutes to write that part. Besides, I'm trying to leave as little room as possible to screw up the getting started portion of the docs.The next step is compiling an app and running it in the simulator. After that, run on a device. Then at the end of that, start documenting actual features like accelerometers, GUI, taps, etc.
#4
09/29/2008 (12:10 pm)
Awesome. I appreciate your documentation efforts.
#5
I realize there are a million things to do when developing a product, but documentation should be an expected part of the package, especially for a $500 add-on to a $250 product aimed at Indies. Like I said, I'm not trying to throw out a negative vibe, but like everyone else here I'm anxious with nervous excitement to play with iTorque, and part of that nervousness is wondering what kind of docs will be available to guide me through it all.
Thanks again for all your hard work, we couldn't do this without you. Now ask for a raise!
09/29/2008 (2:31 pm)
Let me say again that I think it is awesome that you are doing this. Without trying to throw out a negative vibe, I have to be honest and say it amazes me that this is something that you have to do in your spare time as a "hobby." Where's the official company support? Why isn't GG paying you to do this on the clock? And where would we be if you hadn't stepped up to volunteer your time to this project? Yikes!I realize there are a million things to do when developing a product, but documentation should be an expected part of the package, especially for a $500 add-on to a $250 product aimed at Indies. Like I said, I'm not trying to throw out a negative vibe, but like everyone else here I'm anxious with nervous excitement to play with iTorque, and part of that nervousness is wondering what kind of docs will be available to guide me through it all.
Thanks again for all your hard work, we couldn't do this without you. Now ask for a raise!
#6
09/29/2008 (2:44 pm)
Michael is our documentation head. He is...the DOCUMENTOR!
#7
@Patrick - As David mentioned. I am the Documentation Engineer for GarageGames. When I say I'm doing this in my "spare time," I mean that I'm working my 40+ hours week on my normal documentation tasks and spending my non-office hours working in iTorque documentation.
In other words, I'm pulling extra hours to work on docs I'm not currently assigned =)
edit after re-reading your post - I am currently the only dedicated documentation writer for GarageGames. Before I came on, there was no dedicated person. The devs (Zepp, Fairfax, Langley, etc), had to write the docs. The task of writing all the documentation for all the engines is a hefty job, but it's not too much for one person. A tight schedule was set up for all the engines, and then iTorque was released outside my normal realm/schedule.
The engine's release did not quite fit into the 40 hour work week managing the documentation of 6 engines. So, if you are looking for official company support, I'm the source. This is my best effort to work on iTorque documentation. The majority of it does come from TGB and TGE docs, so I'm leaning on those heavily for the time being. Documenting the iPhone specific functionality is not as time consuming as the other engines, but I still am going to tackle it.
Either way, the docs are being written. I'm learning something new and scored an iPod Touch, you all are going to get iTorque documentation ahead of schedule. Win win =)
Thanks for the support!
09/29/2008 (2:51 pm)
@David - Documentor? Awesome! So far I am "Documentation Blackbelt", "DOCUMENTOR", "Doc", and "Loser" (last one courtesy of my manager).@Patrick - As David mentioned. I am the Documentation Engineer for GarageGames. When I say I'm doing this in my "spare time," I mean that I'm working my 40+ hours week on my normal documentation tasks and spending my non-office hours working in iTorque documentation.
In other words, I'm pulling extra hours to work on docs I'm not currently assigned =)
edit after re-reading your post - I am currently the only dedicated documentation writer for GarageGames. Before I came on, there was no dedicated person. The devs (Zepp, Fairfax, Langley, etc), had to write the docs. The task of writing all the documentation for all the engines is a hefty job, but it's not too much for one person. A tight schedule was set up for all the engines, and then iTorque was released outside my normal realm/schedule.
The engine's release did not quite fit into the 40 hour work week managing the documentation of 6 engines. So, if you are looking for official company support, I'm the source. This is my best effort to work on iTorque documentation. The majority of it does come from TGB and TGE docs, so I'm leaning on those heavily for the time being. Documenting the iPhone specific functionality is not as time consuming as the other engines, but I still am going to tackle it.
Either way, the docs are being written. I'm learning something new and scored an iPod Touch, you all are going to get iTorque documentation ahead of schedule. Win win =)
Thanks for the support!
#8
September Documentation Wrap Up Blog
Big thanks to everyone for helping me get through September =)
09/29/2008 (3:56 pm)
Documentation UpdateSeptember Documentation Wrap Up Blog
Big thanks to everyone for helping me get through September =)
#9
www.garagegames.com/mg/forums/result.thread.php?qt=79278
Presumably iTGB would handle the texture conversions automatically, but if not, that would be a critical issue to document. thanks
09/29/2008 (6:21 pm)
Re: what Brian talks about in this threadwww.garagegames.com/mg/forums/result.thread.php?qt=79278
Presumably iTGB would handle the texture conversions automatically, but if not, that would be a critical issue to document. thanks
#10
Thanks for the clarification. :)
09/29/2008 (6:32 pm)
Ah! I didn't know you were THE doc guy. I just saw the spare time comment and thought "What! That's crazy!" Thanks for the clarification. :)
#11
@Patrick - No worries. Contrary to my manager's opinion of my ego (pffft!), I don't expect people to automatically know who I am and what I do. Although, if someone wants to create a fan-club by next GDC I won't argue....
*hey...if Tim Aste can have one, so can I damn it!
**previous comments made in jest
09/29/2008 (7:37 pm)
@Alex - Thanks for pointing that out. I'll keep that in mind.@Patrick - No worries. Contrary to my manager's opinion of my ego (pffft!), I don't expect people to automatically know who I am and what I do. Although, if someone wants to create a fan-club by next GDC I won't argue....
*hey...if Tim Aste can have one, so can I damn it!
**previous comments made in jest
#12
09/30/2008 (7:11 pm)
Is there any iTGB documentation yet, and if so, where is it?
#13
09/30/2008 (7:39 pm)
@Conor - Currently, only TGB documentation is available from GG. I highly recommend you check out the TGB docs and iPhone SDK docs while I work on getting iTGB information together. Be sure to track this thread for updates.
#14
09/30/2008 (8:46 pm)
Thanks Michael - I just wanted to make sure I wasn't missing something obvious :-)
#15
10/15/2008 (12:04 am)
Michael - In the TGB iPhone/Software Setup section there's a few left-over references to TGEA.
#16
October Documentation Wrap Up
iTorque TDN Section
The TDN section is just the landing page. I still need to push content, but at least you know where to start checking in.
11/08/2008 (5:50 pm)
Documentation UpdateOctober Documentation Wrap Up
iTorque TDN Section
The TDN section is just the landing page. I still need to push content, but at least you know where to start checking in.
#17
11/17/2008 (12:29 pm)
Has the wiki moved?
#18
As soon as TDN comes back up, I'll make another post.
11/17/2008 (12:33 pm)
The server box that hosts TDN is experiencing technical difficulties. I've notified our networking person, and he's working on it as we speak.As soon as TDN comes back up, I'll make another post.
#19
11/18/2008 (12:26 pm)
Any news on TDN? 
Employee Michael Perry
ZombieShortbus
- Getting Started Doc: This will cover the soup to nuts installation of xCode, iPhone SDK, and iTGB. After a guide to downloading and installing the required software, the doc will go into detail on how to compile a sample project and run it on the simulator.
- Address issues posted by Patrick in his request thread