Official TGE Documentation Feedback
by Michael Perry · in Torque Game Engine · 05/14/2008 (7:28 pm) · 64 replies
=========================================================================
This Thread Is The Official Documentation Feedback Area For ALL Versions of TGE
If you want to quick search for all TGE Doc Updates, perform a keyword search in your browser for "Documentation Update:"
=========================================================================
Hey everyone. It's about time we have a central thread for TGE users to post their feedback in regard to documentation.
Now, I know there is a Documentation area in the TGE private area, but it makes sense to give non-licensed users a chance to be heard as well.
We have a similar thread going on in the TGEA private 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 TGE =)
Purpose of the Thread:
- Provide a central thread for Torque Game Engine users to post their thoughts, suggestions, and criticisms about documentation.
Targets:
- Official documentation provided by GarageGames, 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 TGE
If you want to quick search for all TGE Doc Updates, perform a keyword search in your browser for "Documentation Update:"
=========================================================================
Hey everyone. It's about time we have a central thread for TGE users to post their feedback in regard to documentation.
Now, I know there is a Documentation area in the TGE private area, but it makes sense to give non-licensed users a chance to be heard as well.
We have a similar thread going on in the TGEA private 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 TGE =)
Purpose of the Thread:
- Provide a central thread for Torque Game Engine users to post their thoughts, suggestions, and criticisms about documentation.
Targets:
- Official documentation provided by GarageGames, 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.
#62
A lot of people are smiling about the new documentation, great job.
I'm finally getting off my butt and making those tutorials for Houdini (I THINK I mentioned it in this thread before)
Still want me to drop you a note when I have a few to show?
Yes, one of the main problems with the doc's are that they are so scattered. It's very hard for a newcomer to get a grip on it, and sort of sit down and go through it from top to bottom, easy to advanced.
Like,
(And for the record, I'm talking about mainly the TGE, because that's the one I have, I do not have any experience with the other engines/techs available.)
1. The tutorial that comes with the engine.
2. Here's a stripped version, showing the server-part and the client-part.
3. Here's how to add basic functions in the GUI (RSS feeds, etc.) And a *blank* GUI, where a tutorial is not based on altering a pre-made GUI/set of GUI's, but rather walk you through how to custom make your own from scratch.
4. Here's how to put in your own characters into the starter.*** packages that comes with the engine.
5. Here's a barebones pre-made separate server/client with nothing but basic scripts and an extensive doc telling you exactly how they're fit together, the functions and what they do (And examples on how to change some basic thing).
6. How to use the Creator-mod and how to rip out the files you generate to put them into your own projects. (Including scripts needed).
That's just a short example of what I would have liked to have seen, and still would to some degree.
Now, I have no clue what comes with TGEA, but I'm guessing it's pretty much the same as what comes with TGE.
The first time I opened up the TGE folder, I was shellshocked.
There seemed to be little structure, the examples was finished, playable games with no documentation other then that written inside the scripts, which was confusing to say the least..
I've spent hours and hours looking up the most basic of things and functions, and I just feel that it shouldn't be necessary when you pay for a complete game-engine.
Yes, I have the Indie-version. But it's the exact same version even if you go for the full commercial engine or one of the high-priced custom-license ones. (Different licenses, different price, same engine.)
11/28/2008 (6:40 pm)
Great to see you're working on this Perry :)A lot of people are smiling about the new documentation, great job.
I'm finally getting off my butt and making those tutorials for Houdini (I THINK I mentioned it in this thread before)
Still want me to drop you a note when I have a few to show?
Yes, one of the main problems with the doc's are that they are so scattered. It's very hard for a newcomer to get a grip on it, and sort of sit down and go through it from top to bottom, easy to advanced.
Like,
(And for the record, I'm talking about mainly the TGE, because that's the one I have, I do not have any experience with the other engines/techs available.)
1. The tutorial that comes with the engine.
2. Here's a stripped version, showing the server-part and the client-part.
3. Here's how to add basic functions in the GUI (RSS feeds, etc.) And a *blank* GUI, where a tutorial is not based on altering a pre-made GUI/set of GUI's, but rather walk you through how to custom make your own from scratch.
4. Here's how to put in your own characters into the starter.*** packages that comes with the engine.
5. Here's a barebones pre-made separate server/client with nothing but basic scripts and an extensive doc telling you exactly how they're fit together, the functions and what they do (And examples on how to change some basic thing).
6. How to use the Creator-mod and how to rip out the files you generate to put them into your own projects. (Including scripts needed).
That's just a short example of what I would have liked to have seen, and still would to some degree.
Now, I have no clue what comes with TGEA, but I'm guessing it's pretty much the same as what comes with TGE.
The first time I opened up the TGE folder, I was shellshocked.
There seemed to be little structure, the examples was finished, playable games with no documentation other then that written inside the scripts, which was confusing to say the least..
I've spent hours and hours looking up the most basic of things and functions, and I just feel that it shouldn't be necessary when you pay for a complete game-engine.
Yes, I have the Indie-version. But it's the exact same version even if you go for the full commercial engine or one of the high-priced custom-license ones. (Different licenses, different price, same engine.)
#63
Well... I agree and disagree.
I agree that it is very frustrating having to sift through thousands of resources, forum threads, and lines of code. It would be nice to have a comprehensive instruction manual.
On the other hand, I bought "a complete game engine", and that's what I got. If I bought a car, I wouldn't expect the dealer to teach me to drive it. Its up to me to figure out how things work, and even though its a lot of irrelevant stuff to sort through, EVERY document I read gives me a little understanding, so I'm learning.
Just my opinion.
Tony
05/27/2009 (5:51 am)
Quote:I've spent hours and hours looking up the most basic of things and functions, and I just feel that it shouldn't be necessary when you pay for a complete game-engine.
Well... I agree and disagree.
I agree that it is very frustrating having to sift through thousands of resources, forum threads, and lines of code. It would be nice to have a comprehensive instruction manual.
On the other hand, I bought "a complete game engine", and that's what I got. If I bought a car, I wouldn't expect the dealer to teach me to drive it. Its up to me to figure out how things work, and even though its a lot of irrelevant stuff to sort through, EVERY document I read gives me a little understanding, so I'm learning.
Just my opinion.
Tony
#64
05/27/2009 (5:53 am)
When I buy a car I expect a complete manual for it ;) 
Employee Michael Perry
ZombieShortbus
September Documentation Wrap Up Blog
Big thanks to everyone for helping me get through September =)