TG2 Documentation

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

Previous topic - Next topic

rcallicotte

Agreed.  But, it sounds like Oshyan and Jo are agreeing with this as something each are ready to do.  Or are they lying?  Just time to get our posies out of our pockets - I'm counting on what Oshyan says and I believe Jo.  But, that acknowledged, I actually expect to see something useful come out of this.  Otherwise, I'll begin to believe that most of what we're doing as consumers is a BETA service for a larger picture:  contract work for major movie companies and advertisers, while we are simply testing the software's functionality while we minions are just having fun.  If that ever could be true, I have always believed it is not (except the fun part  ;D ). 

I trust you Matt and Oshyan and Jo.  And I love this software.



Quote from: efflux on March 13, 2012, 03:45:44 PM
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.
So this is Disney World.  Can we live here?

Tangled-Universe

Quote from: Oshyan on March 13, 2012, 03:51:26 AM
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).

Quote
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.

Do I understand correctly that my >2 year old suggestion on the alpha forums to document "as you develop" is now being effectuated?

So, next time when someone complains development is slow you're saying it's because of documentation and if someone complains about documentation it's because of development?
Come on.

Quote
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.

What system are you talking about? If you want to convince us and give us a general feeling of that things are getting right I think you should be less "vague" and more to the point.

As a starter usually a good system is writing it all down (needs to be done anyway) and then PDF. Has that been done? Everything is documented and only needs to be ported to this yet unnamed documentation system?

Quote
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 appreciate you admit you have your part in this documentation misery, but I don't feel you should feel that guilty. Unless things are indeed written up completely/PDF and only need to be ported, but somehow I'm unfortunately so sure that that's not the case?

Quote
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.

Absolutely true that you have never said anything untrue and that's not sarcastic. However, what is a little bit sarcastic is; what's not true about saying for years on that you're working on it and that it has planetside's 'attention' ;) I say those things to my boss too, but actually only when I feel like doing something I like better. See?

I again appreciate your honesty and the fact that you do care and feel it is your duty.
If you don't feel right about it, why not try to fix it?
This redirects us to the line above. You do feel uncomfortable by it, yet you have the decency to respond to it, which I find one of your strongest personal assets.
However, for years the message has been the same like I pointed out above.

Quote
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.

I know about Planetside's resources. This comes up everytime and like I pointed out in my starting post I was hoping to see other arguments than the regular "resources excuse" etc.
As you can read here below it has to do with a business model and ideas how to approach planning these actions of development/documentation/TG2 promotion by feature film work by Matt. With right/careful planning and discipline you can develop and document along. That's easier said than done, but if it doesn't work then it's one of those 2 things disturbing the process.

Quote
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. ;)

I've answered to that already above. Circular argumentation.
About the poll: you should have understood the message I gave by saying that. Of course I'm not going to start a poll, duh :)

Below I can read that after internal debate Jo decided "to do it" and this rather comes to me it has been a choice because of the lack of progress in documentation which wasn't his responsibility initially.
So I'm not sure where you're really going by saying this.

Quote
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.


Quote
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.

Yeah I happened to make a couple of tutorial and 4000+ messages in the past 6 years with an on average hour a day or so online.
If I'd bundle it into a book it would be pretty thick, almost as thick as a regular manual ;)

Yes it's tough and slow work, but with planning/dedication/discipline like I pointed out before you can write/do a LOT in 6 years.

Quote
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.

Here you go again. Seriously, you should consider stopping with spoon-feeding these messages to people by making promisses again and again and again or by giving people only an impression things are moving. History shows that the outcome is otherwise.

Quote
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

Thanks Oshyan.
Unfortunately it seems that the people of this forum, including the more dedicated openly communicating ones can't get to you guys at Planetside as evidenced by you saying
Quote"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".
Basically this means we can think/say whatever we all want in what way we want, nothing will change.
And you're complaining this makes Planetside look bad, what I'm doing here?

All the users here have tried EVERYTHING and in ANY WAY in the last 6 years.
The first time here I start a long considered message about it here, and although you may not like it how I do it, it's definitely not again ;)

I find this conclusion really disappointing.
Please everyone help me understanding the last quote in any other way than what I'm thinking now, thank you! :)

Cheers,
Martin

Tangled-Universe

Quote from: efflux on March 13, 2012, 03:17:11 PM
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.

See my previous post. So I found too. This is really bad. However, I'm told to believe I'm seeing it all wrong :(

Quote from: efflux on March 13, 2012, 03:45:44 PM
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.

I still won't deal with it. Although I have reasons to, because I'm now being held responsible for possible financial consequences because of this thread.
In Dutch we have a saying "bord voor je kop" which translates to something like being very short-sighted.

Tangled-Universe

Quote from: calico on March 13, 2012, 04:17:14 PM
Agreed.  But, it sounds like Oshyan and Jo are agreeing with this as something each are ready to do.  Or are they lying?  Just time to get our posies out of our pockets - I'm counting on what Oshyan says and I believe Jo.  But, that acknowledged, I actually expect to see something useful come out of this.  Otherwise, I'll begin to believe that most of what we're doing as consumers is a BETA service for a larger picture:  contract work for major movie companies and advertisers, while we are simply testing the software's functionality while we minions are just having fun.  If that ever could be true, I have always believed it is not (except the fun part  ;D ). 

I trust you Matt and Oshyan and Jo.  And I love this software.

I trust them too, let that not be a mistake.

However, you have upright reasons to think and definitely say the things you've just stated.
For the last 6 years, in practice, the situation has been as you described; We have delivered funds for a private toy for feature film production with potential of being a complete product, some day.

I like it that you say that as it has not been the first time I've heared someone saying that to me, so despite I do trust them it's still uncomfortable knowing that others feel like that too. It should be of concern to them or make them feel uncomfortable people feel like this.

Thanks for sharing Rob.

chris_x422

QuoteWe have delivered funds for a private toy for feature film production with potential of being a complete product, some day.

So much rancour Martin, I'm surprised and a little disappointed.

I don't like to chime in on threads like these, but really, I've been following this since this morning and it's just getting out of hand.

I've been a terragen user in a professional capacity for some years now and use many 3d packages. The accusation above is so far from the mark that I felt compelled to respond.

Every software package has it's failings, this is new science, and nothing is perfect, I could also point towards the failings of many others for poor documentation.
But the truth is, as most any artist using these tools every day will tell you, we have to learn mostly for ourselves, it's only through usage and experimentation that we learn truly learn to utilise the tools we have to their best ability.

As a professional user, I am completely happy with the direction the software is heading, and am confident that with time, it will also become a more rounded product, even though it is already a fully functioning tool used daily in many production houses.

This thread should be buried and consigned to a deep pit, it smacks of bitterness and saddens me that a user such as yourself deems it fit to take such steps, when from everything I've read, Planetside staff have been nothing but open and honest regarding all these issues. I'm not just trying to play devils advocate here, the team here have been above and beyond all the other developers I've worked with when it comes to support.

I'll shut my mouth now.

Chris

rcallicotte

Quote from: Tangled-Universe on March 13, 2012, 05:21:19 PM

I trust them too, let that not be a mistake.

Quote from: calicoI know.  I can see it and especially have seen a devotion to making this software better and you have given us all great support.

Quote from: Tangled-Universe on March 13, 2012, 05:21:19 PM
However, you have upright reasons to think and definitely say the things you've just stated.
For the last 6 years, in practice, the situation has been as you described; We have delivered funds for a private toy for feature film production with potential of being a complete product, some day.

Quote from: calicoI hope this is beyond what I'm seeing and just isn't so.  I can see it partially so - great to have this used in large production environments.  But, I really didn't pay money for that to be so for just Planetside.  If that were the case, I would have thought about it prior to paying.

Quote from: Tangled-Universe on March 13, 2012, 05:21:19 PM
I like it that you say that as it has not been the first time I've heared someone saying that to me, so despite I do trust them it's still uncomfortable knowing that others feel like that too. It should be of concern to them or make them feel uncomfortable people feel like this.

Quote from: calicoIt's sort of scary to me.  Not just uncomfortable.  But, then again, I don't know what people have been doing with their time and it really isn't my responsibility to tell them how to use their time.  I see similarities among smaller companies - documentation and advertisement are very challenging areas.  I've always hoped Planetside staff thought about us, too, as being part of a bigger family and I'll continue to believe this until I see something contrary in the assertions today about how we will have good documentation.  Let's go by what people do, as always.

Quote from: Tangled-Universe on March 13, 2012, 05:21:19 PM
Thanks for sharing Rob.

Quote from: calicoTU, I hope it works for you.  As always, I like how we can talk about things rather than fester bad vibes.
So this is Disney World.  Can we live here?

rcallicotte

@Chris, I just don't like how you are addressing TU.

Besides, unless you have spent the hours TU has coming here to help new and old users with as many issues, then how can you not see how disappointing that is to hear someone say, "It's in the wash." and never see anything come of it?  That's disappointing, regardless of even the best of intentions and the greatest of dedication.  Hope you can see the point.
So this is Disney World.  Can we live here?

chris_x422

This is why I really hate these threads, everything gets out of hand.

I am not trying to attack Martin, on any level, and he knows full well that I respect his contributions and his art.

I am merely giving my own perspective, especially on the point to which I was quoting.

Like I said, more than anything it just saddens me.

TheBadger

#23
I have no bad feelings whatsoever, for planetside, the software, for anyone in this community. I feel I got much more than I paid for, something vary rare in the world today.

T-U Listen!
You obviously love this product and this community! That is the only reason you can become so concerned about any issues you see. You obviously feel very vested in the progress of things. But it sounds like you are giving up, and that would be a shame after so many years. I have to say that even though I am not at your user level I feel very strongly about the software and what I think it will help me to do, so I share much of your passion. I think most people here do, just look at what elipsis1 wrote in this thread, and he has only been here for a week or two.

I think that you should take a breath, and talk to Oshyan in privet. It is completely understandable to me, how things can get so hot so fast. This is not just software! its a chance for a lot of people do with their lives what they always wanted.  Fix things with your friends! It has taken a long time to get the software this far, it will take longer still. But a long time is better than never! Believe me, there are many things that I always wanted and know I will never get. But seeing the things you want in the software seems like just a mater of time, even if its a long time.

I think that this thread should be closed soon, it is not going the way I thought it would at the start.

It has been eaten.

rcallicotte

Thanks Chris. Me too.  Trying to help.  Hope I can.


Quote from: chris_x422 on March 13, 2012, 06:28:04 PM
This is why I really hate these threads, everything gets out of hand.

I am not trying to attack Martin, on any level, and he knows full well that I respect his contributions and his art.

I am merely giving my own perspective, especially on the point to which I was quoting.

Like I said, more than anything it just saddens me.

So this is Disney World.  Can we live here?

elipsis1

Quote from: TheBadger on March 13, 2012, 06:45:38 PM
so I share much of your passion. I think most people here do, just look at what elipsis1 wrote in this thread, and he has only been here for a week or two.

Passion is a powerful emotion.  Passion for something can often be accompanied with a lot of emotions that we do not consider "good."

However, when these emotions do manifest themselves, it is important to remember their source.

We all here love Terragen2.  (I sure do)

My passion for Terragen causes me to be impatient.  I don't know what something does, and I don't want to wait or spend hours searching the forum, so I have been posting a lot of questions.  You guys have been very patient with my impatience, and have been helpful and courteous.

Now some other's passion may cause them to wonder how many times they will have to answer these same questions?  I think the issue there is that perhaps they could be moving deeper into TG2, but instead of others to talk "deep stuff" with, most of the time there are newbies like me asking about shaders and node placement.  

Not totally sure, but regardless, passion drives us, and with that passion comes human emotion.

This is not a bad thing, we need to all realize this and try to unify.

Ok, enough "deep thoughts with jack handy."

I surely hope my questions were not the source of all this.  :-\

I cannot think of a better feeling, than to know that your favorite software is still under active development.

Apple and Logic Pro 9 are a prime example of this.  Also, I liked mojoworld a lot, but when it came time to make this purchase, I went with planetside because I knew it was actively being developed.

I'm glad to be here, glad to have terragen, thankful for your replies, glad that support does respond on my questions as well, and just glad that I chose this route.

So, here I am a lot of words later, just ready to keep learning, documentation would help, but I won't let it stop me.  I have gotten to know some great artists by interacting on this forum, and I am glad for it.

Ok, now off to explore and render :)

jo

Hi everyone,

I'm going to lock this thread after posting this. It's not productive and it's not doing anyone any favours. I just want to address some points which I think are important though.

With regards to documentation, some time back Oshyan put a lot of work into building up a documentation base using a commercial application. This was what we were going to use to do all our documentation for things like the nodes. Unfortunately it essentially melted down - the application couldn't handle all the data. Even with help from the developers it was hard to retrieve much of use. It ended up being a bit of disaster but no one was to know. We'd tested the application and it seemed like the best option at the time. That was a setback. Eventually he was able to migrate some information out as the basis for the wiki we are using now.

The wiki is our new system and what we are going to be using for documentation. We will also be following a policy of documenting new features as they're finalised. An example of this is the animation module documentation mentioned above. With the animation module documentation my aim was to get the basics down so that people can read it and understand how things are supposed to work, the specifics of our take on animation. I've also tried to flesh that out with more general information that frankly will be familiar to anyone who's done animation with other apps before. If we were only concerned with CG studio users I wouldn't have bothered but I know there are a lot of other users who are interested in animation and hopefully it will help them get up to speed more quickly. It's certainly not comprehensive and there is more work to do on it, but it's a reasonable start.

We are also going to be steadily documenting nodes. Every week will see the node reference filling out more. We do need to strike a balance between documentation and other tasks, it's really not feasible to drop everything else and just do documentation even though we do feel it is very important.

Documentation has been an ongoing concern for us for a long time. We thoroughly understand all the issues brought up in this thread. Nothing about this thread has changed where we are are headed with documentation because we were already taking steps to improve the situation. It has certainly emphasised that it's very important for people but you'll just have to take me at my word that we already fully appreciate that.

Finally I would like to address the idea that TG2 is some sort of private toy that and we're using consumers as testers and a subsidy for high end work. Nothing could be further from the truth. Really. It's no secret Matt does work for studios on some projects, such as with the Paramount logo work. That's a benefit for the studio but it's also a benefit for Planetside and believe it or not all other users as well. TG2 as it stands is a high end tool. Working in that environment means TG2 gets improvements for those situations that benefit other high end users but these are also often things that benefit all users. A number of fixes and improvements have come as a result of that. There are also new features which get added that can be useful to everyone.

Of course Matt is one developer, I am the other. I can tell you I have never worked for a studio directly. I have only occasionally made changes for a studio project and those were all incorporated into the public version anyway. All my work is aimed at all users, but that's not saying much because so is Matt's. A lot of what I do is aimed at making TG2 easier to use. While I am interested in the CG side of things my particular interest is GIS and that sort of visualisation work. I have been too busy generally to really give rein to that but I am working on some stuff for v2.5 that is the basis for expanded capabilities in that area. I know it will also make doing things with real world data easier for other users too though, and it could also be the basis for some other non-GIS things.

The "private toy" theory has no basis in reality. Some people may perceive that it's the case and that's unfortunate, but I really don't think anything we've done should give that impression.

In some ways part of the problem is that TG2 is a pretty high end tool. We could document it to the nth degree and many people would still find it hard to get to grips with. They wouldn't want to read all the docs for a start! That's not an excuse about the state of the documentation BTW. We have always had the goal of a more approachable version in addition to the high end version and it's something we're slowly working towards, but that's a side issue in this discussion.

Regards,

Jo