[HELP] Documentation needs help

Frank · Last edited by Frank on Thu Sep 14, 2006 6:30 pm; edited 2 times in total

Here you get a chance to contribute to the project. The Krusader Handbook needs help for keeping the documentation up to date. So we are looking for documentation writes and proofreaders, using krusader-cvs is not an issue anymore since you can get krusader-cvs with one mouseklik! klik://krusader-cvs Please contact Frank More help requests can be found on the Help Krusader page. Thanks!

Frank · Posted: Wed Nov 23, 2005 1:51 pm Post subject:

The Documentation coordination will be done by me.
I was thinking for about 3 doc writers, and 1 or 2 proofreaders. Ofcource a docwriter can be a proofreader at the same time.
I can't keep up the good quality of the doc's anymore on my own, since besides the doc's i'm occupied with other things and
our great proofreader Richard Holt is also occupied with the Spanish OpenOffice website.
Docbook-xml knowledge is not required, though it's not difficult to learn (it comes close to html), text files are also accepted, i will convert them to docbook if needed.
You don't need to write perfect English, English is not my native language eighter btw.

Frank · Posted: Thu Sep 14, 2006 6:41 pm Post subject:

Anybody

I can't keep up the current progress of krusader-cvs anymore since i have also other duties ...

shie · Author Joined: 17 Oct 2001 Posts: 1553

and that's a slow going time... what will happen when k2 kicks in ...

_________________
Shie Erlich
Krusader Krew

g3k0 · Joined: 23 Sep 2006 Posts: 1

Hello there! I just saw an ad on sourceforge referring to an open DocWriter position. I have yet to play with Krusader, but am quite interested. I will get back to you and write more. I have to run for now.

Thanks,
g3k0

Frank · Posted: Sat Sep 23, 2006 6:51 am Post subject:

Yes, we have also done an annoucement at SF: http://sourceforge.net/people/viewjob.php?group_id=6488&job_id=26431

The last version of the docs is in cvs and can also read online: http://krusader.sourceforge.net/handbook/
Compiling Krusader from cvs is not so difficult (even if you have never done this before):
http://krusader.sourceforge.net/handbook/faq.html#faq_installation
http://krusader.sourceforge.net/handbook/installation.html
Just drop a line if you need help (you could also check if the compiling instructions are clear enough or not).

If you are new to Krusader you can provide valuable feedback if the handbook is clear enough or not.
You could also provide usability feedback, sometimes we consider functions logic to use, though sometimes they are not but we are used to it

The other thing is that the handbook needs some updates, the last features that are in cvs are not yet documented.
btw. we have also a documentation mailing list http://krusader.sourceforge.net/lists.php

Ofcource i will add some updates in the docs, once i can find some time for it, but currently my time is limited

Thanks!

gyrefalcon · Joined: 18 May 2007 Posts: 1 Location: USA - Midwest

Hi, all.

I'm new to the Krusader Forum but very experienced writing technical documentation.

Would like to help. Perhaps I could start with some proofreading; after I get oriented, move up to writing? ...or analyzing?

Please let me know what you need and any protocols/conventions to follow.

Cheers,

>>Gyrefalcon

Senf · Posted: Sat May 19, 2007 7:08 am Post subject:

Frank!
Frank, o, Feeeennnk!!!

He must be away from his computer, cause usually he answers the questions promptly. In cases when getting help with the documentation is in question, he is faster then lightning.

Frank · Posted: Sat May 19, 2007 11:22 am Post subject:

Hi Gyrefalcon,

I'm occupied with other stuff (as i already mentioned for a long time

) and i'm not always online, from now until July i'm even verry ocupied with other things.

The documentation was proofed recenly but the proofreaders native language wasn't English, so there could be always some issues around.
http://krusader.sourceforge.net/phpBB/viewtopic.php?t=1925

You can always start reading the documentation, so you get used to the docs (it's a large document) and the Krusader program.
Maybe you like to check the Keybindings with the current Krusader, to check if it's still up to date.I have updated it recently but maybe i have missed some Keybindings.
http://krusader.sourceforge.net/handbook/key_bindings.html
Menu: Settings -> Configure Shortcuts
Just take notes, howto edit/modify the documentation i will explain later.

For further instructions please contact me by mail.
http://krusader.sourceforge.net/developers.php

Thanks!

Frank · Posted: Sun May 20, 2007 6:58 pm Post subject:

Bandyt · Joined: 19 Jun 2007 Posts: 3

Frank.

I've read the thread and will download the documentation and get familiar with it. I love Krusader and would eventually get around to reading the documentation anyway (when I needed to).

I'm a recently retired technical writer and available to help out if needed. All previous writing has been done in a windows environment but I'm pretty adaptable. I've been *playing* with computers since the early 80's but just now getting into Linux. God it's nice to finally not need Windows for work! Free, free, thank god I'm free at last! <g>

Let me know what needs to be done and I'll be glad to help out.

NOTE: My job was a technical writer for 26 years. I didn't particularly like it but was good enough to last until retirement

Frank · Posted: Tue Jun 19, 2007 3:01 pm Post subject:

Great news!
Until now i have received some contributions, but for some reason nobody stayed around.
Read the handbook, the online version or the HTML Documentation Snapshot, since they are the latest CVS version (updated every 24 hours from CVS) (I don't maintain or fix the older handbook versions).
During reading, compare it with using Krusader-1.80.0-beta2 or Krusader-cvs, if you find some issues, please let me know (i'm shure some issues can be explained better, some pages are unfinished, some issues are maybe changed because the feauture was changed, and i'm shure there are some minor functions around there that are bad or not documented because i'm not aware of it).
Krusader is an OFM and is easy to use, the advanced functions can be learned afterwards but you need to know how they work before you can document them, and that's the tricky part to find someone to help me with maintaining the documentation (you need to know how krusader works, and follow the talks on krusader-devel mailinglist where the new features are discussed, otherwise it's not possible to write documentation).
You can simply take notes, and i will integrate them into docbook-xml. docbook-xml can be learned also, it's comparable to HTML.

Just drop a line if you have any questions, or send me mail.

Thanks!

Bandyt · Joined: 19 Jun 2007 Posts: 3

ok

My previous job would have called this a desktop validation, A little different terminology but the same process. I have been using v 1.80.0 beta 2 (last unstable stone) so there's no problem with using the correct version(s).

I've been scanning the various Krusader pages and will get down to serious review this afternoon. Is final documentation the only task to complete for 1.80.0 "Final 3 Stones", release date May 07? Maybe we can get it out this month if all programming for 1.80 is frozen.

Just like my old job. Come on a new project and I'm already behind schedule <g>

Frank · Posted: Thu Jun 21, 2007 8:52 pm Post subject:

Thanks!
There is no release date set for 1.80.0 (stable), it will be released when the most important bugs are fixed, but there is a feature freeze since beta2.
We follow the "release when its ready" philosophy

Currently most of the developers (and me) are occupied with other things

, but i'm shure all jobs will be done, it just takes more time than planned.

The documentation changelog gives an overview of the documentation changes, it also contains some todos, but they are not easy if you are not used to use Krusader i guess.

Bandyt · Joined: 19 Jun 2007 Posts: 3

No problem

I don't want to clutter up this thread so I'll submit future comments through email or PM.

In case anyone is wondering I'm not really a highwayman at heart. Meet Bandyt (avatar) our epileptic cat. He's one of the oldest in our menagerie and rules the other cats. We currently have 5 cats (rescued from shelter) and 1 dog. The dog rules them all <g>