Game Development Community

Torque Documentation Project needs help

by Yujiao Guo · in Torque Game Engine · 08/29/2008 (5:57 am) · 4 replies

Background:

I have been trying hard to interprete line by line how the engine works for a long time.
I have never written anything down and I found myself forgetting the meaning of code that I understood.

I have about 40 students 7 of them serious programmer wanting to contribute to our startup game company. Currently torque engine has been the engine we have been considering using.

In order to do serious development on the torque engine, however, we have to understand how everything works exactly, so we could add code to it.


Project details:

Therefore, I am thinking about creating a project for torque engine owners who is interested to
document the entire engine. Explain what every line of code that is not totally clear does.
I have been trying to do some documentation. However, since there are too much code for one person to do
a really complete documentation that is easy to understand even for those new to the engine.
I am thinking having more human resources and different intelligence they bring along would make the
whole project more do-able.

Question:
Since I am not familiar with the whole server stuff (don't even know how to setup and run a server). Could people please give some suggestions as to what to do to setup something so it is easy for my own company members and torque owners to contribute to the documentation.
For example, is it best to somehow setup my own server that runs all the time so poeple could update the documentation with subversion? Or is there some public website I could use to accomplish this?

Thanks a lot.

Yujiao

#1
08/29/2008 (9:03 am)
@Yujiao Guo - As Documentation Engineer for GG, that's the kind of post I love to read! =)

I can tell you one thing I know for sure: Line by Line documentation of the source and script code is a huge undertaking. One person can get the job done, but they have to truly enjoy writing documentation and dedicate all of their working time toward it (*cough*).

I'll be posting another documentation announcement next week, which you will find very interesting and helpful. Outside of that, I hope this thread gets some attention.

If you are serious about generating documentation (of any kind), we can talk more hear or privately via my e-mail (found in profile).

Look for a major documentation announcement next week.
#2
08/29/2008 (9:53 am)
Quote:Look for a major documentation announcement next week.

Woot! Finally!
#3
08/29/2008 (10:38 am)
Quote:Woot! Finally!

Finally? O_o

Guess you missed the past 2 major announcements? =)
#4
08/29/2008 (12:08 pm)
@Yujiao Guo
I might suggest looking into doxygen (a great program for converting source code "comments" into documentation html pages or windows help files, which is already in use in the engine), and also setting up an svn server.