Documentation, Tutorials & Demos

[rodlie]

This issue covers discussion around documentation, tutorials and demo files for v1

This project needs documentation, at least basic UI/UX workflow and exporting video vs. SVG etc.

Due to limited resources this has never been a priority, I use Friction at work and doing documentation is just a waste of time (from my POV).

But, new users will of course have issues without any kind of documentation.

So, it would be nice to have basic documentation ready for the next major version. First let's figure out what's important, what is the most important documentation needed? What is our target users? Can we assume some basic animation/graphics know-how?

[mokalux]

hello there, please allow me some feedback.

Enve is an awesome piece of software and with friction you bring it to the next level.

In my opinion you don't need writing documentation, it takes a lot of time and energy. What I would suggest is making little tutorials like enve did. For example: a title (eg. export to mp4) and a quick video, done. Even making/editing video take time, so take it easy.

You are making an awesome job with friction and I thank you for that.

[Pebor]

As a normal (linux) user, somewhat technical but using creative software solely for fun and experimentation:

A lot of people look at adobe for example when looking at linux and don't wanna switch, because why would they shoot their own leg if the decide to try something in AE, or Premiere, etc. I am one of those people, and now a lot of others, so I am assuming it's more common (with younger students at least)

When looking at linux/open source alternatives, for motion design, enve was basically the only thing actually made for motion design, so it was the option worth trying first - ofc that had some issues. Issues which this project tries/did solve quite a bit I think? (definitely in terms of scariness.

My point being, a lot of people with little to no experience will probably at least look at the website and quickly try it. If you are a profesional already, you are either using something else, or already know what to expect and how to work with this program more intuitively.

I think targeting the more casual demographic would be nice. Videos as mentioned above are good, but a "book" (like rust, or maybe godot styled) with screenshots and a one or two examples showcasing the features would go a long way in not just quickly getting profesionals on track, but also holding the hand and motivating the curious ones.

[doc-halo]

Regardless of the target audience, you should still have the basic documentation:

• Interface Introduction
• How to create shapes
• How to edit shapes
• How to animate This should be the first start and will ensure those new to animation aren't forgotten. And this shouldn't be hard to document. I can help with documentation.

Videos are more important in this day and age, so basic tutorials will help.

@rodlie As the developer, who do you think the target audience is right now? I'm not sure but I do use friction for basic animation and motion design stuff for hobby projects.

[rodlie]

As the developer, who do you think the target audience is right now? I'm not sure but I do use friction for basic animation and motion design stuff for hobby projects.

I (and the company I work for) uses it professionally and there might be talks about getting Friction used in education. Outside of that it's made available for anyone to do what they want, if that is professionals or just someone that want to play with animation.

From my POV Friction is aimed at artists that already has basic knowledge about animation/graphics, they have prior experience with similar tools.

[rodlie]

Added basic framework for the docs: https://github.com/friction2d/friction2d.github.io/commit/56d9f01cd2641d19b968e9cebe469d7066bb8c54

# Friction Manual

* [Installation](installation.md)
* [User Interface](userinterface.md)
* [Shortcuts](shortcuts.md)
* [Export](export.md)
* [Expressions](expressions.md)
* [Plug-ins](plugins.md)
* [FAQ](faq.md)

Still need to add content of course.

[irwant]

I think this good idea to create documentation about how to use a tool in Friction. that can help people like me when trying to using alternative software. Before, I am user AE, and switch to using Linux because of some reason. I just need a couple hour to know how i can create a motion using this software. I think this simple software because not too much unwanted tool and plugin

[eFe-Munoz]

Hello people, greetings to all. I was already working a few years ago on a reference manual for Enve in English and Spanish. Since it is discontinued I am going to change it to Friction and make the necessary updates. I will do it when I can spare some time, for now I am very busy.

The manual is still missing a lot of things but it is on the right track.

https://theflydesign.es/manual-enve-2d-animation-english/

https://theflydesign.es/manual-enve-animacion-2d-espanol/

[rodlie]

@eFe-Munoz Nice, take your time. No rush.

I have created a basic "framework" for the docs, you can find it at https://github.com/friction2d/friction2d.github.io/blob/main/documentation/index.md

It's plain markdown, can be converted to html/pdf.

[eFe-Munoz]

great news!

[ghost]

@eFe-Munoz I just went through your documentation to get started with Friction and it's still quite helpful. I would love to help move and update some of that content into the documentation framework that Rodie set up here.

I come from an Adobe background 15+ years in Design/Illustration and have spent the last 3 years teaching and creating tutorials. I'm currently switching to open-source and Linux compatible alternatives where I can.

I think Friction has the most potential to replace AE for me out of the dozen or so alternatives I've tried and I'd love to contribute via documentation and video tutorials.

[rodlie]

I would love to help move and update some of that content into the documentation framework that Rodie set up here.

Any help will be appreciated. I will soon start my vacation and will have some extra time to spend on Friction. I will flesh out the current framework a bit more, it's currently just doodles. I will also document how to contribute.

I come from an Adobe background 15+ years in Design/Illustration and have spent the last 3 years teaching and creating tutorials.

I have not used Adobe products since CS2, so I'm a bit "out of the loop" regarding the major tools. Feedback is welcome (and important).

I'd love to contribute via documentation and video tutorials.

That is awesome :+1:

[rodlie]

Added basic info about masking (due to #226)

https://github.com/friction2d/friction2d.github.io/blob/main/documentation/tutorial-masking.md

Should probably record a video, maybe later.

[candidexmedia]

I found two tutorials online which were good quality:

https://www.youtube.com/watch?v=MGfsq8WYNnQ

https://www.youtube.com/watch?v=5T8F-9YovME

[rodlie]

Will try to finish basic documentation this week (at least enough for the beta).

[eFe-Munoz]

Great news!!! waiting for BETA!

[kaixoo]

I think personally that creating your own docs isn't the most important thing. I would prioritise keep the workflow intuitive and make it as much AE-like as possible so people can recycle their own knowledge. I learned a lot about Friction just by viewing After Effects tutorials.

Of course when there is something unique / not very visible to the user about Friction we should have a way to communicate it. I think in-app docs are better than web docs for that (e.g. interactive tutorials within the app to show that you can create ECMA expressions)

I think also at this point in the development there should be a developer introduction for contributors (not just how to build the software, but about the code structure and APIs used), and perhaps we should move to the typical workflow in open source projects which is that every change is a PR (so that many people can collaborate)