TG2 Documentation

Started by Tangled-Universe, March 12, 2012, 06:56:16 PM

Previous topic - Next topic

Tangled-Universe

Hi All!

TG2 Documentation... Why does T-U start a topic about TG2 Documentation? Isn't he one of those guys who knows everything?
The answer is neither yes or no and perhaps is rather closer to no than yes.

Reading Oshyan's reply below  and the second link made me write this long considered post:
Here's the specific message:
Quote from: Oshyan on March 10, 2012, 04:01:38 PM
On the plus side, many of the features of 2.4 are already well documented. We're improving our methodology for documenting as we go, and particular thanks go to Jo for putting in the time to well document the animation features.
- Oshyan
and
http://forums.planetside.co.uk/index.php?topic=14139.msg138489#msg138489

This topic above is just one of the most recent examples of an abundance of examples about the lack of documentation.
The equally abundant type of evasive official reply made me start this topic.
My method of making my point may not be as rock solid, as usual :) lol, but I'm trying to achieve something here by starting another discussion and I hope me posting about this at least makes people interested or curious/wonder as I'm being considered a TG2-pioneer/-die-hard-supporter here and generally don't start these type of topics out in the open.
This in itself should be a strong signal and because of the following:

Oshyan, I have spoken with you about this for, say, the past 2 years (maybe even more) and besides the many words of promiss not much has changed or happened in the field of documentation.
I reckon Jo did his fair share of work as evidenced by the function node reference and the documentation of the upcoming animation module which some of us have the privilege to see (and work with) already.

So that's the reason for starting this. Somehow, the community (these forums) and it's pioneers/alpha-testers (alpha testers forum, 2 year IM) can't seem to get the documentation being finished and delivered. This is a pretty serious problem.

To get back to the message quoted above:
I wonder why you mention the documentation of the animation module (which is not officially available yet) as an achievement here in reply to sounds of criticism (by Elipsis1).
People don't have it yet, so it's not relevant and not completely honest towards them if you'd ask me, just bait to keep people satisfied and these type of replies are very typical when people inform about the documentation process.

This software is out for almost 5,5(!!) years now and documentation is still pretty meager and can't even keep up with the pace of development (except for the documentation by Jo), which isn't rather fast as well, but that's a whole other discussion of course. That's pretty shameful in my opinion.
In the future development on TG3 will start and as things look now documentation on TG2 still won't be available then.

I think it's very fair of people to demand final documentation now after so many promising words but little acts during the existence of TG2 for >5 years.
The vast majority of topics/posts here are mostly due to lack of documentation and a significant part (of those) are complaints about the absent documentation.
I'm curious what the outcome will be of a poll asking people whether they'd like a version upgrade or a complete official documentation?

In this already lengthy post I haven't even dealt with the possible loss/lack of growth of the TG2 userbase or the potential commercial use of TG2 because of this documentation issue.
I hope others will share their thoughts/opinion here and especially Planetside on their real plans for documentation other than the usual excuses and promising words.

Cheers,
Martin

rcallicotte

I don't have as good of a relationship with Oshyan and the Planetside staff as you do, TU.  So, I can't quite address the depths of what you are saying here to the Planetside staff.  But, I agree with this - having documentation nailed down is a strength of appeal to any software package.

That said, I believe we have a lot of information on this site - lots of files, lots of how-to, lots of open experimentation and even some documentation to help someone begin from a new user start.  I think the poignant, and even pressing, issue for you is the realistic fact that you are answering almost every user post where someone has a question here.  You are a storehouse of knowledge of TG and this is evident in how well you answer everyone and how articulate you are in your answers.  You answer new and seasoned users with as much information as is possible and usually give us more than we ask for, which is wonderful.

So...I'm thinking you are feeling this lack of documentation even more than most of us here, though others help with user questions, too, and probably feel what I'm pointing out.  I imagine if I were you, I would not want to feel that I'm the living documentation for TG and that having some good documentation and how-to manuals available are key to the prosperity of Terragen.  With this, I agree wholeheartedly.

Thanks for posting something so important to you and so helpful to the community.
So this is Disney World.  Can we live here?

Tangled-Universe

Thank you Rob :)

I did not address anything specifically from my relationship with/to the Planetside staff.
I used the fact that I, but also quite some other long period/experienced users, speak with Oshyan/PS on a relatively intensive basis as an argument.
The argument that all you users here who requested for documentation for ages now plus guys like me discussing this with Planetside directly, all together, can't seem to get this issue moving.

Quote
So...I'm thinking you are feeling this lack of documentation even more than most of us here, though others help with user questions, too, and probably feel what I'm pointing out.  I imagine if I were you, I would not want to feel that I'm the living documentation for TG and that having some good documentation and how-to manuals available are key to the prosperity of Terragen.  With this, I agree wholeheartedly.

Yes, this is partially the case. Though Oshyan probably likes to use this now as being 'THE reason' for me. Which it is not.
The point is: if this glorious product wants te evolve, you need proper documentation.
Exactly like you said.

Quote
Thanks for posting something so important to you and so helpful to the community.

Thanks for your support. I must say I was (still am) quite reluctant to post this, hence I considered it for quite some time.
If this topic will be helpful to the community? Time will tell.

jo

Hi Martin,

We're fully aware of the issues surrounding documentation. Believe it or not we're working on it right now. We have experienced some setbacks in the past which slowed things up but that's the past. The node reference has been slowly but steadily filling up over the past few months. The window reference has been expanded. Preferences and menu docs have been updated. An Input Settings reference was added. Documentation has been added for many of the new features in v2.4.

You bring up the animation module documentation. I don't think Oshyan mentioning that is being evasive at all. It represents a significant amount of work and it's important to have documentation in place so that people can quickly get up to speed with what is a significant new chunk of TG2. We could have chosen to keep it private until the 2.4 release but decided to put it up sooner (although we haven't really talked about it) because we thought people might be interested in it and it was a bit more convenient to do it that way. That's it, no conspiracy or ulterior motives. I don't think it's very fair to complain about documentation and then criticise us for having it!

The fact is that time spent documenting the animation module is also time not spent documenting the nodes, for example. That's the tradeoff we have to make though. In this case we thought it was important to hit the ground running with documentation for this and other new features in v2.4 precisely because we do know we haven't done a great job of documentation to date and we're aiming to make things better.

It's not a fast process writing the documentation. I'm in the middle of doing the Surface Layer node at the moment and it's a good many hours work. Some of the simpler nodes can take nearly as long if there's graphics needed to explain what the node does.

Believe me the documentation is a big issue for us too. We completely understand all the points you bring up. I personally find the lack of documentation frustrating as I don't know what everything does by any means and it would be great to just look it up!

Regards,

Jo

TheBadger

If at any point it becomes a question of, which items to finish first. I would vote for the *?* icons in the node windows to be finished first. Just from my perspective now, I think this product feature would give me the most immediate benefit.

On the other hand I would like to point out, as a new learner of 3D, that other 3D programs often have better documentation but are still harder to learn because they lack this kind of community. As Calico pointed out, you T-U and everyone else here go a long way to making up for any lack of documentation. (I'm Speaking as a student here more than anything). So yes, I would love to have some comprehensive documentation to drown in for a while, but I hope that it would never be used (some how) as a replacement for the kind of personal instruction I get from Oshyan and T-U and others. It is a simple fact (of experience) that if what I received from this community was sold at a university it would cost thousands of dollars per person, and I would still not get as much personal help from a teacher. To me, this is the overriding value of TG2.

I'm probably not adding much to the conversation here, but I can only speak from a limited point of view on this subject. I guess my (selfish nature) leads me to ask two questions:
1) Will I be able to understand the in-depth documentation T-U is talking about?
AND
2) Will having this documentation, and understanding it, help me to find work using TG2 as a professional?

It has been eaten.

jo

Quote from: TheBadger on March 12, 2012, 09:03:50 PM
If at any point it becomes a question of, which items to finish first. I would vote for the *?* icons in the node windows to be finished first. Just from my perspective now, I think this product feature would give me the most immediate benefit.

The "?" buttons link to the node reference which we are slowly but steadily filling out.

In answer to your questions:

1) We are certainly trying to make the documentation easily understandable. Where possible we will include things like images, movies and example files to help you understand a node better. Here are some examples:

http://www.planetside.co.uk/wiki/index.php/Crater_Shader (movies from links, will change so they display inline)
http://www.planetside.co.uk/wiki/index.php/Shader_Array
http://www.planetside.co.uk/wiki/index.php/Heightfield_Clip_Vertical

Those sorts of things in addition to the text do take quite a lot of time so the emphasis will be on (hopefully) understandable text documentation with extras to follow over time.

That doesn't necessarily mean we're explaining every single thing in minute detail. There are some concepts like normals or displacement for example which are common amongst all 3D work and which you can easily find out more about by doing a web search. Down the track we may write about these things in a TG2 context but they are basics which can be found out about pretty easily and so we'll concentrate on TG2 specific things initially.

2) Perhaps, if it helps you to become a more effective TG2 user, which we hope it will. Of course your creativity and ability will play a major part in that as well.

Regards,

Jo

rcallicotte

#6
Side note:  Let's never forget what the world was like without TG2.  I remember TG1.  Once TG2 is actually completed and Matt says, "Now it's time to move on.", perhaps then the documentation will be readily available from a base software program without possible tweaks - this makes documenting a package much more sensible and definitely makes the work simpler.

[reading animation documentation now...heehee!!]
So this is Disney World.  Can we live here?

Oshyan

I brought up the animation system documentation because it is the first real example of "document before you release", which is what I would think is exactly what you want. It seems your take on what I said speaks more to a seeming distrust of Planetside (or me) on your part than any deception on mine, and that's a bit confusing to me considering your evident devotion (which we appreciate, of course).

In any case the animation system docs represent an intended new approach that, while not comprehensive, will nonetheless have an increasing impact on future releases. In other words major new features should be better and better documented *as soon as they become available*. Taking care of documenting old features is also being very actively worked on, as Jo mentioned, and big thanks go to him for that as he's taking significant time to do it, time which could be spend developing or doing other work.

Martin, since you've put your questions so pointedly here, I'll try to be as straight and clear as possible:

We've gone through multiple systems for the documentation and some bad decisions have been made (mostly by me) regarding how to do it. We have now found what we believe, and what is proving to be, a good system to handle documentation long-term. It addresses the major need for interlinked documentation that can be updated easily and quickly by multiple people (removing the bottleneck of a single person doing docs). It's also an expandable system, allowing us to add new features like video, etc. We feel it is a good basis on which to build.

Documentation has primarily been my responsibility and I have not attended to it nearly as much as I should have, plain and simple. Remember all those years of "There will be another Terragen (0.9) release soon!" or "TG2 final is coming!"? Matt never said those things because he wanted to lead anyone one, he really thought it would happen "any day now". He had good reason to believe that, but things happen.

I have never stated anything about the documentation that is untrue, but circumstances change, issues arise, delays occur. I could simply stay silent when these threads up, but I do care, I do want to help people and satisfy the desire for documentation, and I feel like it's my duty to respond when the question comes up. Perhaps it would be better if I just ignore them if I don't have a major documentation update to point to, but it doesn't feel right to me.

Lack of time is a significant limitation in our ability to document this software. There are 3 total staff at Planetside at this point. 2 of them are essentially full-time developers (Jo and Matt, of course). That leaves me to do most everything else, which includes marketing and PR, partnerships (e.g. Ranch), testing (I tend to test features the alpha testers don't necessarily dedicate the time to), web maintenance, and of course documentation, among others. My time is also somewhat limited because quite frankly Planetside does not currently support a full-time living salary for me (living in San Francisco, an admittedly expensive city). So I have to do other work and balance it with my TG/Planetside time.

Jo is now taking time to do documentation, and that's great, but it's time he doesn't spend on dev. We could debate and poll all day about what people want more, new features/releases or documentation. The obvious answer is both. ;)

Another big problem is that neither Jo nor I actually know the most about TG. Jo knows a lot about certain elements, and can look under the hood at the code, checking code comments and whatnot, to figure out what some things may do, but ultimately Matt knows the most, by far. So there are limits to what either Jo or I can document properly and fully. Matt's time is most at a premium because he focuses on the beating heart of TG, the rendering engine, shaders, and associated systems.

Documentation is very time consuming, especially if you want to do it well. From taking screenshots and/or video, to simply writing out clear descriptions that can be understood by people who are not already experts in computer graphics, it's tough, slow going work.

On the bright side we are currently in significant internal discussion to address the documentation issue. This has been spurred largely by Jo, and he deserves major credit for taking initiative on it, though it is of course always on all of our minds. Coming out of this discussion will be increased efforts by all on documentation. As past history has shown, committing to specifics is often unwise. The proof is after all "in the pudding". So we'll see how the pudding tastes down the road.

Finally, I suppose that, as last time, you may feel that posting your concerns in this pointed manner has spurred things along and helped the situation. I want to make clear that everything I've said above is a simple statement of fact, of prior existing reality, and is uninfluenced by this thread and the pointed way in which you've chosen to bring the subject up again. I know you feel this is "the only way to get things done", but I just don't see it. We make the efforts we can and have mostly the same goals and desires as you and the other dedicated users, we're not enemies, and being adversarial does not, in my view, help anything. Speaking only for myself, frankly this approach only discourages me.

I hope that helps answer your questions and concerns.

- Oshyan

Kevin F

Well!
I see the argument here from both sides and can sympathize with Oshyan and Jo to a degree, having to work with such a limited number of staff (down from 4 to 3 now I believe), but as a customer and almost daily user of TG now for well over ten years, I do think the lack of pertinent documentation is lamentable. If Planetside intends to be a major player in the CG world (and I know it does) you simply have got to expand and take on more staff. For years now you have struggled on with less than a handful of staff and the impression is one of a hobbyist/part-time application, albeit an incredibly good one, that is just too slow in development (including documentation) to be taken on as a serious contender to the big boys.
In my view your whole strategy needs to be reconsidered. Just where are you up to in development? You've had alpha testers now for many years, and once every eighteen months or so we get an update to a product that is still in production after 5 years in this incarnation! (don't get me going on the 5 years before).
Are we yet to have beta testers? and when can we realistically expect to see TG3? I know you guys don't like making predictions (given your track record), but you do give the impression of extreme caution with regards to future dates and the number and frequency of updates. And before you berate me I do know the consequences of releasing  buggy software, but again it's all down to the issue of insufficient staff and not being able to cope with the demands of development, marketing, documentation etc.on a scale that keeps the customers satisfied.
Given your dips into the "professional world" such as the Paramount logo venture and numerous other uses of TG in movies, surely it must be possible to secure enough financial support for more staff?
Sorry to sound so negative but these things need to be said. The quality of the software is so good, it's such a pity that the rest of the package is spoiling the overall experience.

jo

Hi Kevin,

TG2 is not still in production as such. It has been a final, proper release all round since v2.3 when the Mac version came out of beta and the Windows version was considered final prior to that. TG2 is of course still a work in progress but only in the way that all software being actively is.

The alpha testers are really a combination of alpha and beta testers. We don't do betas anymore as such. Alpha testers get access to new features which are very early in development but by the time a public release comes around we are confident that new additions since the last release are working as best they can. Some additions have a basic level of functionality which will be expanded upon in coming releases because if we waited to include everything we wanted to there'd never be new releases.

We do actually have v2.4 coming out shortly. We're aiming to get v2.5 out more quickly than previous releases and that will round out some of the new stuff to be introduced in v2.4 and also add a few new things. Then we'll be concentrating on TG3.

Regards,

Jo

Kevin F

Thanks Jo for your quick response.
Would be nice to get the Boss on here with regards to expansion etc. ;D

jo

Hi Kevin,

We definitely have plans for the future but those are sensitive business information and it's not appropriate to discuss them in a public forum. Obviously we are a smaller player going up against one dominant player in particular but we are in it for the long haul and Planetside is not a hobby for us. I'm having a hard time trying to remember when exactly using TG was a hobby for me, well over 12 years now anyway! Funnily enough around that time I did work for a competitor getting their Mac version up and running but despite a big talented team in several locations around the world, significant investment by the founders and eventually VC funding that product seems to have been essentially defunct for some time. We're still here and are not planning on going away. It's true we aren't quite where we want to be but we're determined to get there.

I think this discussion has pretty much run it's course, from our perspective anyway. We do respect people's opinions but there is nothing here new to us, believe me.

Regards,

Jo

elipsis1

Whatever you guys at planetside do: Don't ever stop making terragen :) :) :)

I'm SOOO addicted!


efflux

#13
Martin.

On that other thread you said "This is what you get when you release software in 2006 and after almost 6 years"

On the Modus Operadi thread I actually started posting a message with those EXACT same words. Then I just abandoned it, seeing it as pointless.

efflux

Just another point here.

"In this already lengthy post I haven't even dealt with the possible loss/lack of growth of the TG2 userbase or the potential commercial use of TG2 because of this documentation issue."

I think is is actually a huge key issue. I understand the difficulties because it does take time to write documentation but at some time priorities need to allow for it.