What do you think about Documentation?
by Michael Perry · 05/15/2008 (7:10 am) · 3 comments
***Greetings all!***
Let me get it out of the way right now:
This is a NO frills .plan. I wish I had some pretty pictures or wicked exciting news, but this blog exists purely for informative reasons. I'm tired, I just got back from an hour long dentist appointment, and I can't have my morning coffee because it keeps spilling out of my completely numb mouth. So, please forgive me if I can't scour the internet for LOLCat pics to post here =)
DOCUMENTATION
A dreaded word....Everyone WANTS it, a lot of people hate writing it, and the writing process will NEVER be finished since new versions of the engines are being released all the time. Thankfully, there is a group of people who still want to do the work, and even one insane person who actually LOVES writing documentation...ahem...
TGEA Started It All
During the TGEA 1.7 beta, I created a thread in the private forums: TGE 1.7 Documentation Feedback. The purpose of the thread was to provide a central location for TGEA users to post their feedback, criticisms, and suggestions for the new docs. The response was overwhelmingly positive, constructive, and key to getting new docs and fixes to the user for the release.
So, it's time to show the same attention to the users of the other awesome Torque engines. Stephen Zepp has created a thread in the TGB area, and every other engine has its own as well. Going a step further, the new threads are posted in the PUBLIC area, just to show some love to the people who have yet to purchase a SDK. Every opinion counts, and your feedback will help out in more ways than one. =)
TGEA Documentation Feedback
TGE Documentation Feedback
TGB Documentation Feedback
TorqueX (TX) Documentation Feedback
TorqueX Builder (TXB) Documentation Feedback
In each thread, there is an explanation, purpose, and suggestions on what we are looking for. Each thread will be monitored carefully, so let's get this rock rollin'
Edits: Image links removed due to old website being compromised. They weren't that great anyway =/
Hope that makes up for it.
Let me get it out of the way right now:
This is a NO frills .plan. I wish I had some pretty pictures or wicked exciting news, but this blog exists purely for informative reasons. I'm tired, I just got back from an hour long dentist appointment, and I can't have my morning coffee because it keeps spilling out of my completely numb mouth. So, please forgive me if I can't scour the internet for LOLCat pics to post here =)
DOCUMENTATION
A dreaded word....Everyone WANTS it, a lot of people hate writing it, and the writing process will NEVER be finished since new versions of the engines are being released all the time. Thankfully, there is a group of people who still want to do the work, and even one insane person who actually LOVES writing documentation...ahem...
TGEA Started It All
During the TGEA 1.7 beta, I created a thread in the private forums: TGE 1.7 Documentation Feedback. The purpose of the thread was to provide a central location for TGEA users to post their feedback, criticisms, and suggestions for the new docs. The response was overwhelmingly positive, constructive, and key to getting new docs and fixes to the user for the release.
So, it's time to show the same attention to the users of the other awesome Torque engines. Stephen Zepp has created a thread in the TGB area, and every other engine has its own as well. Going a step further, the new threads are posted in the PUBLIC area, just to show some love to the people who have yet to purchase a SDK. Every opinion counts, and your feedback will help out in more ways than one. =)
TGEA Documentation Feedback
TGE Documentation Feedback
TGB Documentation Feedback
TorqueX (TX) Documentation Feedback
TorqueX Builder (TXB) Documentation Feedback
In each thread, there is an explanation, purpose, and suggestions on what we are looking for. Each thread will be monitored carefully, so let's get this rock rollin'
Edits: Image links removed due to old website being compromised. They weren't that great anyway =/
Hope that makes up for it.
#3
07/22/2008 (2:35 pm)
Can i ask if you guys are using .Net XML tags in the code. If you guys are then please tell the programmers to put some ///examples in. I would be a happy man :D 
Torque 3D Owner Deborah M. Fike
Default Studio Name