Make an user guide

[AAClause]

The problem

The current documentation is not a good documentation but: a short description of the add-on + a listing of gestures mapped by the add-on. Also, the add-on contains several features that should be documented.

Suggested solution

In the first time, I'll write a French documentation (from the 21st). Then I'll ask for help with the English translation (due to my English not being good). I hope to integrate the English and French documentation in mid-January. The current documentation will be renamed something like “Profile gestures list”.

[zstanecic]

Hi,

I am tempted to close this, as the current documentation describes the usage of the add-on well.

Even Russian, polish and Croatian documentation are good translated examples.

It’s not because I have did so, but it’s because I had feedback from users.

[AAClause]

I disagree. In my opinion, the current documentation is too minimalist. Each feature should be detailed (including a description, use cases and/or examples). Features such as braille dictionaries or HUC Braille may not be obvious for the user without some basic explanation.

[zstanecic]

Yes, but this should be translated in a .po file like before, with the interface.

Along with this, please include the comments for translators

[AAClause]

My final goal is to include the add-on to the translation system. So, I'll write the documentation in Markdown and I'll add comments for translators, yes.

[zstanecic]

But try to add the existing strings when adding it to the translation system, as I don’t want my work to be destroyed, cause there are glossary terms and consictent translations

[AAClause]

Don't worry about that. :) Most of strings should not change! :) Thanks a lot (again) for your contributions.

[zstanecic]

I will continue with this…

[bdorer]

This would help a lot. For example smart Caps Lock isn't well described without a guide.