Skip to main content

User manual structure

7 posts / 0 new
Last post
rylleman
rylleman's picture
Offline
Joined: 03/18/2008
Posts:
User manual structure

I've looked a bit into the user manual to see if I could help documenting.

I feel the structure is a bit hard to follow now and would need a (careful) rework.

First the reference guide is divided into versions. Right now everything is documented under 0.7.4 which means it's already old.
I think we need to move everything out of a version structure. If it's possible to add tags or similar we could mark each document with the version it's written for. When a new version of Kdenlive is released we can then go through the documentation and either confirm or update the documentation and update the tag to the new version number.

Next I can't find any glossary or index making it hard to find content and use the manual for quick reference.

Is it possible to mark content into categories and groups? Is it possible to have group pages like in wiki pages? - All content marked with a certain category is listed on a category page?

0
Your rating: None
LeHomard
Offline
Joined: 10/30/2008
Posts:
Re: User manual structure

I agree, Kdenlive would need a good up-to-date documentation. There are quite a lot of "hidden" features around, which is a pity. One of the main problems is that the software is evolving quite quickly, so it would have to be updated regularly (with each release).

rylleman
rylleman's picture
Offline
Joined: 03/18/2008
Posts:
Re: User manual structure

I've browsed a bit more, trying to add content and I must say I think the site software is a blunt tool for documentation. I started to add Menu items and for each and every item with subitems you have to add a new page. Tedious work.

Why was the documentation moved from a wiki into Drupal? Any other reason than to have everything collected in the same site I mean? Would it be possible to integrate a wiki site into the current Drupal site for documentation?

ttill
Offline
Joined: 10/14/2009
Posts:
Re: User manual structure

I would also like to have a Wiki.
This would make it a lot easier for people to contribute to our documentation.

Granjow
Granjow's picture
Offline
Joined: 12/24/2008
Posts:
Re: User manual structure

Thumb up for that :)

Weevil
Weevil's picture
Offline
Joined: 05/09/2008
Posts:
Re: User manual structure

Agreed also, 'Your first Kdenlive project' from the user manual or videotutorials from Kdenlive 0.7.1 just don't work for me (although greatly appreciated) when I want to learn something new quickly. A wiki containing all the elements of the program might be a good way to keep users informed and turned on to the software.

ttill
Offline
Joined: 10/14/2009
Posts:
Re: User manual structure

Please take a look at this thread in our mailing list:
http://sourceforge.net/mailarchive/forum.php?thread_name=4C437040.900060...