Documentation moving forward

It has been discussed off and on for a long time. Filter Forge needs better documentation. I am willing to throw my hat in the ring... I would start such a project if FF hired me. A long shot, but hey, I have a lot of experience writing these things. What I think is needed:

1) High level User's Guide - Shows how to use the tool without going into the gory details of RGB math or editing. More on use of the filters, less details on editing & components.

2) Component Reference Manual - Goes into the details of all the components, including examples of how they are used. Snippets should be included with examples for all components.

3) Filter Creation Reference Manual - Goes into the details of using the editor and creating and editing existing filters.

4) Tutorials - videos? HTML?
a) Rules for writing efficient filters.
b) Bomber.
c) Noise.
d) RGB math

This list is incomplete and a few of these things are done, all off the top of my head. I feel the Component Reference Manual would be the most useful place to start on my list. My 2 cents, 3 with inflation.

+1000... I agree at 200%

The docs are basically really just dry reading of what the program does. I think some of the expert-level stuff ends up in the Wiki, which usually contains more "human friendly" content.

I just honestly wish it were a couple steps easier to edit the wiki, like creating forum threads like these. I know it's not hard, I just can't afford to spend hours on end writing up detailed wiki articles with formatting, for that matter, I'd rather get paid to do that.

Quote
the wiki and forum can help but surely is not enough

I mean there's already quite a load of information on both these places. Unfortunately the Forums are time-based so things get buried unless it's a sticky thread. The wiki is honestly kinda getting old so the info there needs major updating. And we probably need to plant some new articles in the desert lol.

I would honesty disagree with the "not enough" part though. The info's just scattered and there's no way to make a definitive list.
[Addendum] You know, the FilterLibrary is technically a really really good resource for "how tos" in the sense that you can pick apart filters to its core functions and start rebuilding stuff from there. Although gotta be careful with it: I would recommend looking at the editors picks more than filters in the recent list due to the fact that the filters are curated for their quality.

Quote
I would honesty disagree with the "not enough" part though.

I disagree.

Quote
I disagree with your disagreement smile;) Especially when it comes to component descriptions. A complex product needs a reference manual. With examples, descriptions of what each component does, range of values, typical usage for each component etc etc.

I agree with you Rick !

Quote
I disagree with your disagreement smile;) Especially when it comes to component descriptions. A complex product needs a reference manual. With examples, descriptions of what each component does, range of values, typical usage for each component etc etc.

Oh snap, that IS true. So it's basically not enough in the sense that there's barely any technical information on specific subjects for example math or it's just buried.

I was more so thinking about general information in terms of creating stuff in FilterForge. I did give out several example works, hints, etc over years so I feel like there's an accumulation of information all scattered throughout these forums that either nobody understood or didn't care. (I.e. Sharing Noise thread)

I think that thread might as well be part of the wiki. Hum. The thing is, I really don't know if I've contributed to people's understanding or if I just wasted time writing about my favorite tool. lol.

So I mean yeah, why not an artist-friendly documentation rather than the dry, hardcore documentation we got so far?

Another thing: If you, me, us, we or whatever are going to make creator friendly documentation, there's gotta be a section on designing with FilterForge in mind. You can write all about technical stuff but it makes no sense if you can't make good stuff with it. I think people get tech crazy these days that people forget the nature of art and design. To me that would be as important as understanding the tech.

Thanks all for the great input.

Quote
So I mean yeah, why not an artist-friendly documentation rather than the dry, hardcore documentation we got so far?

Good point. The component reference manual would show how each component worked with other components (if a snippet or good example is provided with each description). For instance, using ArcTangent with Derivatives.

Quote
Another thing: If you, me, us, we or whatever are going to make creator friendly documentation, there's gotta be a section on designing with FilterForge in mind.

The editor reference manual would probably be the place for this. The manual probably needs a combination of "dry" sections (commands, options, etc) and sections which show how to use the editor to create a filter. This could be separate documents...

In the end, specifics on organization are less important that getting both the high level and low level information to create filters in a manual.

I Totally agree that one of the really needed things for FF is really a much better documentation and tutorials to learn better how to use all the nodes and all the possible combinations and have the fundamental knowledge to be able to get all the really huge potential that FF really has because this is like having a super power millon dolar car and only use it at city at 50 miles per hour.

I have downloaded the trial of the ON1 Photo RAW 2022 software and has a manual of 225 pages explaining everything you may need and with many examples and how to get the most of the software. And of course there are also lots of youtube tutorials also available.

Is really a pity that such awesome, excellent, powerful and full of power software that is filter forge that has such great huge potential can not be really used the most because is needed more documentation specially for people that are beginning and may be hard to learn and can miss the opportunity to use it right.

In lots of online learning websites like Domestika, Skillshare, Udemy and many others there are lots of tutorials about mostly any other software BUT regretably NOT about filter forge, and is really a great pity.