Game Development Community

Official Torque 3D Documentation Feedback

by Michael Perry · in Torque 3D Beginner · 10/21/2009 (1:59 pm) · 207 replies

=========================================================================
This Thread Is The Official Documentation Feedback Area For Torque 3D

If you want to quick search for all Torque 3D Doc Updates, perform a keyword search in your browser for
"Documentation Update"
=========================================================================

Torque 3D Wiki

Documentation Landing Page

Official Documentation

By using this thread as a central source to leave documentation feedback, we can keep the other forums clean.

Feel free to post any criticism, suggestions, bugs (missing images or dead hyperlinks), outdated information, etc.

Purpose of the Thread:
- Provide a central thread for Torque 3D users to post their thoughts, suggestions, and criticisms about documentation.

Targets:
- Official documentation

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?
- 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!

You can find the archived feedback thread from the beta here: Beta Documentation Feedback.

Known Issues

- Docs are in progress

7/17/09 Update: Tooltips work. Component Tutorials work in certain browsers. CLICK HERE for SVN Change Log.

7/31/09 Update: Posted full TOC for docs, using WIP template to hold spot for final docs to be written. CLICK HERE for SVN Change Log.

9/24/09 to 10/14/09 Update: CLICK HERE for full SVN change log

2/4/2010 Update: First major update to documentation pushed. Meant to coincide with 1.1 Beta, but full 1.1 docs are not finished. CLICK HERE for list of changes.
#101
12/15/2009 (3:05 pm)
I just started working through the documentation which is referring to ForgeSoldier and other assets that my full install of a new project is not including. I was told to post this here by Scott Burns to make sure it gets included in the documentation updates at some point.
#102
12/15/2009 (5:27 pm)
So we are almost 1 month past the release of T3D alpha? Any news on puting up the docs that were going to be released the same day regarding the new editors and such?
#103
12/20/2009 (8:38 am)
@Mich
TGEA/TGE's high level engine documentation is quite good, maybe you should come up with a T3D version. Oh by the way, engine oxygen doc is still broken.
#104
12/25/2009 (4:00 pm)
Would it be possible to add a timestamp to an article? So I know when it was last updated. Thanks.
#105
12/28/2009 (4:38 pm)
Michael:
TYPO: "Click the New button, found at the bottom next to the garbage bein,"
Should be "bin"

docs.torquepowered.com/torque-3d/official/content/documentation/Beginners%20Guid...

Suggestion: A tutorial for adding controls, i.e. an invert mouse option, and how to code/expose more buttons and make them bindable in the control panel options. Maybe a nice example of multiple zoom levels implemented by rolling the mouse button. (Took a while to find the links so I just posted a new response.)
#106
12/31/2009 (1:39 pm)
Quote: 12/07/2009:
I think tomorrow is the best guess for the full push of all the new content.


Let me guess... Next year? Maybe? ;)

I hope this basic written documentation isn't taking a back seat to that video tutorial you mentioned working on.

I think it would be less frustrating if you could post a word or two, the next day, on why the documentation didn't get updated when you thought it would, instead of keeping us waiting for weeks wondering...

I am not trying to make anyone feel bad... I don't like having to post this but I am more curious on just what is going on... what happened that caused an expected push to be delayed by now over three weeks after you mentioned that all the server problems were worked out and everything was ready to go.

#107
12/31/2009 (3:40 pm)
I'm pretty sure Mich mentioned in this thread the reasons behind the delay, or I'm thinking of another thread.

Either way, the reasons behind the delay were due to the move to Vegas, a server issue that came up due to the move, and now of course the holidays.

Just be patient, Mich has been continuing to work on the docs all this time and you guys won't be disappointed when the update finally goes live.
#108
12/31/2009 (4:17 pm)
That quote I posted came from 'after' the server issues had been cleared up and it looked like the next push was imminent, as he said... and then nothing for weeks.

It's really no big deal. I'm just saying - with the intent of it being constructive input that is said to be valuable to businesses like this - that just a few words to keep us informed would go a long ways in terms of customer relations and keeping us more patient than frustrated.


Thanks


Have a good Blue Moon New Years celebration.
#109
12/31/2009 (4:18 pm)
The holidays definitely through a wrench in the plans, but the main reason is because of the persistent server issue.

I tried several times to push new documentation with no luck. Because others are moving or on vacation, there is no clear channel of communication to find out what is going on. I'm going to try again on the 4th, when everyone returns to work.

No, the specific video tutorial series has not interfered. However, good news on another front. Since I have not been able to push written documentation, I have been recording very simple video tutorial for specific parts of the engine. For example, I recorded videos about Toolbox, World Editor Interface, and GUI Editor interface. I'm never, EVER, idle when something is not working.
#110
12/31/2009 (4:30 pm)
Now that's what I'm talking about! I'm satisfied anyway...

And the video exploration of the engine sounds very good!

Thank you Michael! ^__^

#111
01/11/2010 (5:38 pm)
@Michael - No resolution to the server issue yet? Do you want me to post them up for you until it gets fixed? I can have them up and available in about 5 minutes if you send them over...

I could use some details on zones and portals if you're looking for something to do while you wait for the server to get fixed...lol
#112
01/21/2010 (12:09 pm)
And for the n-th time, only the sound of crickets.
#113
01/21/2010 (12:21 pm)
It will be worth the wait. With the Beta looming, we've begun to strip out modules and eliminate the remaining docs that were on my TO-DO list. I just finished up the more advanced and lengthy docs, such as GroundCover (36 pages, phew).

This was no small update. The daily and short updates were counter-productive. Even when the server is fully fixed, there is no time for me to go back and rewrite docs due to engine or interface changes. We are now treating engine development as it should be: Alpha = new features and major changes, Beta = bug fixing and polishing. As we leave Alpha, I can lock down my writing and screencaps without the fear of having to "do it all over".

I repeat, it will be worth the wait.
#114
01/21/2010 (3:05 pm)
MIchael,

Did you ever get a chance to add back in some of those tutorials that were in the beta docs? I'm a real document hound even if I know how to do something I love to read docs and some of those tutorials looked like they were going to be very good. The ones i'm referring too were in the beta 5 docs - creating a swamp, valley, beach coast, etc...

Thanks,
#115
01/21/2010 (8:45 pm)
I think a lot of the frustrations come from a date promised and then not delivered on ( at least for me), rather then the time it takes to release an update, Ive noticed a lot more complaints about timeliness on documentation then say engine updates and I really think it is due to a time line set and then missed. I personally work in a deadline world as well how hard it can be to meet those deadlines. I would like to suggest Michael that it may be better for our frustrations, and for the sanctity of the F5 key being mashed repeatedly on the day promised for a new doc push that comes a few months later that these personal deadlines or your intentions not be shared with us, unless barring an act of god you will be able to deliver as promised. As frustrating as the when it is done attitude can be, it is still better customer care/service then it will be done on this date, and then months go by without the promised update. Making a promise to a customer and then not delivering only serves to lose that customer to the competition...Just my 2 cents, and I only bring it up because this latest promised push that did not happen on time and in fact comes months after it was promised is not the first occurance.
#116
01/21/2010 (8:59 pm)
To be fair...having our documentation publishing system disabled unexpectedly during the move was pretty much an "act of god" =)
#117
01/21/2010 (9:32 pm)
i certainly would agree, and is perfectly understandable, I only bring up this point as this instance is not the first time, albeit this time has to do with a technical issue, and I personally would prefer to avoid another instance were as a customer feeling frustrated when my shiny new toy isn't delivered on the day or at least close to the day it is promised, I would rather no promises then a broken one...but that is just my opinion.
#118
01/21/2010 (10:21 pm)
@Ken - Whole heartedly agree, which is why after this next push I will not be giving out any estimates on when a doc update will happen. I'll just post responses to feedback and notification of new docs.
#119
01/23/2010 (9:59 am)
So 10/14/09 was the last doc update, and the next one will be posted at the top of this forum? Why not send an email update out to registered users when docs are updated?
#120
01/24/2010 (2:06 am)
This has probably already been said, but I'd love a tutorial on how to make an extremely basic game from the ground up, something very simple like a 3d pong or breakout style game - just to help understand the t3d framework. The current idea of "tell you how the engine works, not how to make a genre of game" is good, but will be more use to seasoned coders fluent in c scripting, and less use to utter newbies needing some direction - like meself. Look forward to next doc update.