Skip to Content

Ask for documentation writer role

28 replies [Last post]
jmpoure
Offline
Joined: 10/20/2008
Posts:

Ask here to become a member of the documentation group.

5
Your rating: None Average: 5 (1 vote)
kbeecher
Offline
Joined: 01/22/2009
Posts:
Re: Ask for documentation writer role

As an ethusiastic user of kdenlive, the only real downside has been the lack of proper documentation. So I'd like to help remedy that, and offer to author some documentation.

jmpoure
Offline
Joined: 10/20/2008
Posts:
Re: Ask for documentation writer role

Done, thanks.

Sloshy
Offline
Joined: 11/15/2008
Posts:
Re: Ask for documentation writer role

I'm up for it. I'd really like to write some pages on the effects and transitions if possible.

jmpoure
Offline
Joined: 10/20/2008
Posts:
Re: Ask for documentation writer role

Done, thanks.

giannisfs
Offline
Joined: 05/12/2009
Posts:
Re: Ask for documentation writer role

I would like to post some video guides about kdenlive effects , transitions etc
I prefer to use no sound (is that ok ? ) but i will provide a brief description in text
Thanks in advance

j-b-m
Offline
Joined: 05/19/2009
Posts:
Re: Ask for documentation writer role

Ok, I updated your permissions. No problem if you make tutorials without audio!
regards

giannisfs
Offline
Joined: 05/12/2009
Posts:
Re: Ask for documentation writer role

Thanks

rayl
Offline
Joined: 12/31/2008
Posts:
Re: Ask for documentation writer role

Could you please add me as a documentation writer as well? i probably won't have time to document for a few weeks, but i'd like to be in the system already when i do get a free moment and the documentation urge strikes.

also, i have some tweaks to the book module CSS and PHP code which i use for documentation on my personal home drupal. i can send patches if you are interested.

thanks
ray

ArtInvent
Offline
Joined: 10/02/2008
Posts:
Re: Ask for documentation writer role

I can probably help out with documentation - as soon as I figure out things work, which is hard because there isn't much documentation . . . Anyway, sign me up.

fitzpm01
Offline
Joined: 06/11/2009
Posts:
Re: Ask for documentation writer role

Hi,

I have some experience in writing documentation and I think I could probably contribute something.

However, before getting onto content, I think a framework might be in order- but who do I discuss this with? When I say 'framework', I don't mean some scary chapter and verse structure, what I'm thinking of is that probably a task-based approach would be helpful. Generally, developers are good at documenting their own work- i.e. "on this screen you enter these parameters which plug into the capture algorithm...", which is great and very necessary; but there's also a place for the howto approach of "To capture a video from your camcorder, follow these steps...".

I don't think it should take too long for a few right-minded people to bash out a set of task headings (wouldn't this be what some people call a workflow?) and 'hey presto', there's the framework...

Is anybody with me?

Regards,
M.

jmpoure
Offline
Joined: 10/20/2008
Posts:
Re: Ask for documentation writer role

As of today, the approach is : pick-up an issue, the first who makes it wins. Then ask for help and try to make a team.

For example, this thread:
http://www.kdenlive.org/forum/i-cant-select-any-solved

I asked to write a short howto explaining why codecs where missing and how to install them.
Now way, it does work. I had to write the three lines myself.

As a conclusion, I would recommand that you modify the documentation step-by-step, in a way that it is never broken or unreadable, until you reach a suitable result.

fitzpm01
Offline
Joined: 06/11/2009
Posts:
Re: Ask for documentation writer role

Okay, your approach is good; it's also compatible with mine! All I'm saying is that, once a howto has been written, it can be placed in a framework so that people can find it. Your example would go somewhere around the introduction, perhaps under a heading "Okay, I've installed Kdenlive and it doesn't work..."

Obviously, not all parts of the framework will be filled in to begin with (perhaps not even very many), but it can fill up over time. And if anyone has a bit of time on their hands and is wondering where to direct their documentation energies, they can look at the framework and see what sections are empty(/iest).

Regards,
M.

jmpoure
Offline
Joined: 10/20/2008
Posts:
Re: Ask for documentation writer role

The only rule is that when you start a small project, you have a commitment to finish the work. This is why working on small batches is somehow more interesting.

MJ Peg
Offline
Joined: 05/31/2009
Posts:
Re: Ask for documentation writer role

Just a suggestion or two, regarding your online image/PR ...

Perhaps somebody might like to help to update this wikibook?
http://en.wikibooks.org/wiki/Kdenlive

There are a number of out-of-date sites like this...
http://liquidweather.net/howto/index.php?id=112
- would it be worth the effort to get in touch with such site owners and update them?

In general, if you want as many 'customers' as possible you'll need to make sure that casual browsers looking for a new editor gain the most favourable impression possible of the product... although it will probably pan out just fine on the basis of "if you build it they will come" if it does the job :)

rylleman
rylleman's picture
Offline
Joined: 03/18/2008
Posts:
Re: Ask for documentation writer role

I would like to be in the documentation group.
I don't have very much spare time and can't promise to get more than a few items done. But every little drip counts, right?

waynevid
Offline
Joined: 11/24/2008
Posts:
Re: Ask for documentation writer role

The Wikipedia Kdenlive page could use an update too; very sparse when compared to other video editors. It's still using the old Kdenlive logo too.

waynevid

Anthony Stevens
Anthony Stevens's picture
Offline
Joined: 05/19/2010
Posts:
Re: Ask for documentation writer role

I'm not sure if this is the place, but here goes.
A while back, long before I discovered this forum, I created a couple of book trailers using Kdenlive. As part of my learning process, I documented my experience as a four-part tutorial on my blog. Perhaps these links might be useful to some other newbie?

http://masteranthonystevens.com/2009/12/25/how-to-create-a-trailer/

http://masteranthonystevens.com/2009/12/26/how-to-create-a-trailer-part-...

http://masteranthonystevens.com/2010/01/01/how-to-create-a-trailer-part-3/

http://masteranthonystevens.com/2010/01/10/how-to-create-a-trailer-part-4/

After my next novel is released, I'll have time for another video project. That too, will be documented in my blog.

geoffrey
Offline
Joined: 03/15/2008
Posts:
Re: Ask for documentation writer role

Would you please grant me the permission to be part of the documentation group on the website. I could try to fill in a few missing entries here: http://kdenlive.org/user-manual

Thanks, Geoff

ozdroggy
ozdroggy's picture
Offline
Joined: 08/27/2010
Posts:
Re: Ask for documentation writer role

New to Kdenlive but have been converting film/camcorder for years. Just working my way through Kdenlive and documenting 'problems' and shortcomings in the 'manual' as I go. Is this the sort of think you are looking for?

Kdenlive Capture.

For a camcorder to be recognised it must be connected to a Firewire port and switched on before system BOOT. Then, after opening Kdenlive, it can be connected and controlled using the Record Monitor toolbar.

Note: When connected and PAUSED, 'motorboating' will be heard in the audio. Press STOP to switch off.

If so - please sign me up.

Mike.

ttill
Offline
Joined: 10/14/2009
Posts:
Re: Ask for documentation writer role

We plan to move to our documentation to KDE userbase:
http://userbase.kde.org/Kdenlive
You might want to help there.

kevin-deldycke
kevin-deldycke's picture
Offline
Joined: 05/21/2010
Posts:
Re: Ask for documentation writer role

Hi, I would like to update the manual regarding MLT compilation from sources ( http://www.kdenlive.org/user-manual/downloading-and-installing-kdenlive/... ). Some dependencies are missing. Can I get write permissions on the online manual ?

kevin-deldycke
kevin-deldycke's picture
Offline
Joined: 05/21/2010
Posts:
Re: Ask for documentation writer role

Thanks j-b-m for the edit permissions ! :)

vt.medeiros
Offline
Joined: 10/19/2010
Posts:
Re: Ask for documentation writer role

Hi, I'd like to contribute on Kdenlive Manual!

Thanks

ttill
Offline
Joined: 10/14/2009
Posts:
Re: Ask for documentation writer role

Like I said before: It would be great if somebody could update the Wikipedia page or start working on the KDE Userbase page.

jimglaze
Offline
Joined: 12/19/2010
Posts:
Re: Ask for documentation writer role

I would like to apply to be a documentation writer. My user name is jimglaze

samuelleal
Offline
Joined: 05/04/2011
Posts:
Re: Ask for documentation writer role

Hi,

I'm working in a project that we are using KDEnlive in video workshops for indigenous population in Brazil. For that, we are using some parts of the KDEnLive manual, and I've updated the quickstart session to the version.

I'd like to contribute with this update, and with the translations to Portuguese that we are going to do soon.

regards!

samuel.

samuelleal
Offline
Joined: 05/04/2011
Posts:
Re: Ask for documentation writer role

in fact, I've updated this Quickstart: http://www.kdenlive.org/user-manual/quickstart-guide/kdenlive-first-project

There is a link to this user-manual in the first page? I couldn't find it...

klaatu
Offline
Joined: 11/10/2011
Posts:
Re: Ask for documentation writer role

I've written about 30 pages, in the form of a 6-part article, on using Kdenlive. The articles cover basic editing, advanced timeline editing, effects and transitions and compositing, colour correction, audio, and general tips and workflow.

It's being posted, one article per week, on opensource.com, starting today. I don't know if the article could be of any use...I don't know if it would qualify as a "quick start guide" or just a "kdenlive for dummies" type thing, but it is Creative Commons, so if you guys think it's useful at all, feel free to let me know. I could probably adapt it or just provide an ebook of it, or whatever.

If not then, well, at least it exists and helps promote Kdenlive :^)